Core Library0.xAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

method libtmux-swift latest

Server.wait(for:)

Blocks until something signals channel.

Source and package
Qualified name
Server.wait(for:)
Declared in
Server
Package
libtmux-swift
Source
Sources/LibTmux/Wait.swift
Other languages
Perl Erlangfunction PowerShell Julia Elixir Haskell Common Lisp PythonRuby Lua TypeScript RustGo Java C#C++ Kotlin Scala OCaml F# Clojure
wait(for: String) -> ()

Description#

Runs in a process of its own even on a connected server, because a control client runs one command at a time: carried over the connection this would hold back every call beside it, Server.signal(_:) included, and nothing would ever release it.

  • Throws: TmuxError.serverRestarted if the server went away while this was waiting. tmux releases its waiters when it shuts down, with the same silent success a real signal produces, so the server's identity before and after is what tells a release from a departure. TmuxError.cancelled if the task was cancelled, which ends the wait without a signal.
Parameters
Raises

tmux command#

The tmux commands behind wait(for:).

tmux C API#

The C declarations in tmux that implement these commands.

Guides#

Pages that discuss wait(for:).

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
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
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#.

Esc

Type to search.

Reference previewOpen reference