Ruby API

method libtmux-ruby v0.1.1

Server.wait_for

Retiring the client cannot remove a dispatched waiter from tmux's queue.

Source and package

Qualified name: LibTmux::Server#wait_for
Module: LibTmux
Declared in: Server
Package: libtmux
Source: gems/libtmux/lib/libtmux/operations.rb
Other languages: PowerShell Julia Elixir Python Lua TypeScript RustGo Java C#C++Swift Kotlin Scala F#

def wait_for: ( ::String, ?action: :wait | :signal | :lock | :unlock, ?timeout: ::Numeric, ?cancel: untyped ) -> ::LibTmux::CommandResult method libtmux [source] ¶

Description#

Behavior contract: Wait channels.

Examples#

Wake a blocked request from another thread with a cancellation token and read the delivery evidence on the Cancelled error. Use Ruby 3.3 or newer with Bundler, and tmux 3.3a or newer, on Unix with /bin/cat and /bin/sh available. In an empty directory, save this Gemfile:

source "https://rubygems.org"

gem "libtmux", "0.1.1"

Save this complete program as cancellation.rb. Its Server.start() block owns a private tmux server and stops it on exit, including after an error. View source

# frozen_string_literal: true

begin
  # docs:begin main
  require "libtmux"

  LibTmux::Server.start do |server|
    server.new_session(name: "work", command: ["/bin/cat"])
    cancellation = LibTmux::Cancellation.new
    waiting = Thread.new do
      server.run(["wait-for", "-S", "ready", ";", "wait-for", "held"], timeout: 5, cancel: cancellation)
    rescue LibTmux::Cancelled => error
      error
    end
    server.wait_for("ready", timeout: 5)
    cancellation.cancel
    failure = waiting.value
    puts "request: #{failure.class}"
    puts "delivery: #{failure.delivery}"
    cancellation.close
  end
  # docs:end main
rescue StandardError => error
  warn "#{error.class}: #{error.message}"
  exit 1
end

Install the gem and run the program. An operation or cleanup error makes it exit unsuccessfully:

$ bundle install && \
  bundle exec ruby cancellation.rb

Expected output:

request: LibTmux::Cancelled
delivery: possibly_sent

Parameters

arg1 (::String) #
action (:wait | :signal | :lock | :unlock) #
timeout (::Numeric) #
cancel (untyped) #

tmux command#

The tmux commands behind wait_for.

wait-for

tmux C API#

The C declarations in tmux that implement these commands.

cmd_wait_for_entry cmd_wait_for_exec

In other ports#

Wait for, signal or lock a channel

Equivalents of Wait for, signal or lock a channel in other languages
Language	Equivalent
Python	`libtmux.Server.wait_for`
TypeScript	no equivalent on `Server`
Rust	`server.Server.wait_for_channel`
Go	`tmux.Server.WaitFor`
Java	no equivalent on `Server`
C#	`LibTmux.Server.WaitForAsync`
C++	`libtmux::Server::wait_for`
Swift	`Server.wait(for:)`

No equivalent is recorded in Lua, PowerShell, Julia, Elixir, Kotlin, Scala or F#.

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

Server.wait_for

Description#

Examples#

tmux command#

tmux C API#

In other ports#

Description#

Examples#

tmux command#

tmux C API#

In other ports#

Related types#