io.github.libtmux.Channel.Channel

class io.github.libtmux.Channel.Channel

classreadonly [source] ¶

classreadonly [source] ¶

class io.github.libtmux.Channel.Channel

One of tmux's wait-for channels, named once.

<p>A channel is server-wide and shared by everything on it, including programs running in panes. Nothing creates or destroys one: a name either has a signal remembered against it or does not.

<p>tmux's own wait-for has two traps, and this exists to close both. It exits successfully when the server dies under the waiter, which is indistinguishable from a real signal, so the server is checked afterwards rather than believed. And a signal sent when nobody is waiting is remembered, satisfying the next wait whenever that happens — possibly in a later run of a different program — so #drain() is how a caller starts from a known state on a channel whose history is not its own.

Members

• await method Waits for something to signal the channel.
• awaitReservingCapacity method Waits while preserving process capacity for a call through this server that signals it.
• Channel method
• drain method Consumes a signal already waiting, so a stale one cannot satisfy a later wait.
• name method The name this channel is known by on its server.
• signal method Signals the channel, waking one waiter, or being remembered until something waits.
• toString method