Python API

method libtmux latest

Server.wait_for

Wait for, signal, or lock a channel via $ tmux wait-for.

Source and package

Qualified name: libtmux.Server.wait_for
Module: libtmux
Declared in: Server
Package: libtmux
Source: src/libtmux/server.py
Other languages: Perl Erlangfunction PowerShell Julia Elixir Haskell Common Lisp Ruby Lua TypeScript RustGo Java C#C++Swift Kotlin Scala OCaml F# Clojure

wait_for ( self, channel: str, lock: bool | None = None, unlock: bool | None = None, set_flag: bool | None = None, ) → None method [source] ¶

Examples#

>>> server.new_session(session_name='wait_test')
Session(...)
>>> server.wait_for('test_channel', set_flag=True)

Parameters

channel (str) # – Channel name.
lock (bool | None) # – Lock the channel (-L flag).
unlock (bool | None) # – Unlock the channel (-U flag).
set_flag (bool | None) # – Set the channel flag and wake waiters (-S flag).

The tmux commands behind wait_for.

The C declarations in tmux that implement these commands.

Pages that discuss wait_for.

Wait for, signal or lock a channel

Equivalents of Wait for, signal or lock a channel in other languages
Language	Equivalent
Ruby	`LibTmux::Server#wait_for`
Erlang	`tmux_command:wait_for/2` Builds a command value; construction performs no I/O.
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
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:)`
OCaml	`Libtmux_unix.Client.wait_for`
Perl	No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands.

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