Server.WaitFor
WaitFor waits for, signals, locks, or unlocks a named tmux channel. It changes only that server-side channel state; cancellation can interrupt the client wait but cannot prove a preceding signal or lock did not take effect. See tmux.WaitForModeLock: before tmux 3.8, abandoning a lock wait costs that channel one unlock.
Source and package
- func (s Server) WaitFor( ctx context
.Context , request WaitFor , ) errorRequest -
Description#
On a
Connection-bound server a wait or lock runs on a control client opened for that call and closed when it ends, so canceling it, or a peer never signaling, leaves every lane free. Closing the connection ends a parked call withErrControlClosed.tmux ends a waiting client with success when the server exits, which reads as a signal. A wait or lock that tmux ends that way is checked against the server and returns an error matching
ErrNoServerwhen the server is gone. A signal followed at once by the server exiting reads the same way.- Parameters
tmux command#
The tmux commands behind WaitFor.
tmux C API#
The C declarations in tmux that implement these commands.
Guides#
Pages that discuss WaitFor.
In other ports#
Wait for, signal or lock a channel
| Language | Equivalent |
|---|---|
| Python | libtmux |
| Ruby | Lib |
| Erlang | tmux 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 |
| Java | no equivalent on Server |
| C# | Lib |
| C++ | libtmux:: |
| Swift | Server |
| OCaml | Libtmux |
| 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#.