io.github.libtmux.Server.Server

class io.github.libtmux.Server.Server

classreadonly [source] ¶

classreadonly [source] ¶

class io.github.libtmux.Server.Server

One tmux server, reached over one transport.

<p>Ownership is decided at construction and never inferred. #open creates a transport this server closes exactly once; #using borrows one the caller keeps, so several servers can share a transport and closing one leaves the others working.

<p>Closing a server closes a client, not a tmux. It never kills the server process: sessions outlive the program that made them, which is the entire point of tmux.

Members

• Builder class Collects configuration and the ownership choice, then builds a server.
• attachedSessions method Every session a client is attached to, captured now.
• awaitChannel method
• batch method Collects several commands to run in one tmux invocation.
• bindKey method Binds a key to a tmux command.
• buffers method The server's paste buffers, which every session shares.
• builder method A builder holding the documented defaults.
• chain method Starts a chain of commands where each one acts on what the last one made.
• channel method One of this server's wait-for channels, which is where a signal is sent and waited for.
• clearPromptHistory method Forgets what has been typed at tmux's command prompt.
• clients method Every attached client, captured now.
• close method Releases an owned transport. Idempotent, and never kills tmux.
• cmd method Runs one tmux command against this server.
• config method How this server was configured.
• expand method Expands a tmux format against the server, and answers with what it came to.
• globalOptions method The global session options every session inherits unless it sets its own.
• hasSession method Whether a session with this name exists.
• hooks method The global hooks every session inherits.
• identity method Which server this is. Every handle taken from it is scoped by this.
• ifShell method Runs one tmux command or another, according to whether a shell command succeeds.
• isAlive method Whether the server is running and answering.
• killServer method Ends the tmux server and every session on it.
• killSession method Ends the session with this name, and everything in it.
• listCommands method Every command this tmux knows, as it prints them.
• listKeys method Every key binding, as tmux prints them.
• lock method Locks every client attached to this server.
• messages method The server's own message log, newest last.
• newSession method Creates a detached session and returns that exact session.
• open method A server over a transport it owns and closes.
• options method The server-wide options, the ones tmux keeps once per server.
• panes method Every pane on the server, captured now.
• promptHistory method What has been typed at tmux's command prompt, oldest first.
• raiseIfDead method Checks the server is answering, and says so loudly when it is not.
• refresh method
• requireSameIncarnation method
• requireSameServer method
• run method Runs a command that is expected to work, and raises when it did not.
• runShell method Runs a shell command through tmux, for its effect.
• runShellCapturing method Runs a shell command through tmux and answers with what it printed.
• runTogether method Runs several commands in one invocation, so nothing of this caller's happens between them.
• sessions method Every session, captured now.
• snapshot method Captures the whole hierarchy in at most four listings, retrying once if the server is replaced.
• sourceFile method Runs a file of tmux commands, as a configuration file would be run.
• toBuilder method A builder holding every configuration and ownership choice this server made.
• unbindKey method Removes a key binding.
• using method A server over a transport the caller owns. Closing this server never closes it.
• version method Which tmux this server is running.
• windows method Every winlink on the server, captured now, including a linked window once per session.