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.

enum libtmux-java latest

WakeReason

Why a wait on a tmux channel ended.

Source and package
Qualified name
io.github.libtmux.WakeReason
Package
io.github.libtmux
Distribution
io.github.libtmux:libtmux
Source
libtmux/src/main/java/io/github/libtmux/WakeReason.java
enum io.github.libtmux.WakeReason

Description#

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.

Members3#

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

Guides#

Pages that discuss WakeReason.

Esc

Type to search.

Reference previewOpen reference