io.github.libtmux.WakeReason.WakeReason

enum io.github.libtmux.WakeReason.WakeReason

enum [source] ¶

enum [source] ¶

enum io.github.libtmux.WakeReason.WakeReason

Why a wait on a tmux channel ended.

An enum rather than a boolean, and rather than nothing at all, because tmux's own wait-for cannot distinguish these: it exits successfully both when the channel is signalled and when the server dies underneath the waiter.

Discussed in Waiting and retrying

Members

• SERVER_GONE constant The server is gone. tmux reports this as a successful wake, so it is checked for rather than believed; a caller cannot rely on anything the wait was guarding.
• SIGNALLED constant The channel was signalled.
• TIMED_OUT constant Nothing signalled the channel before the caller's deadline.