LibTmux::Server

class LibTmux::Server

classlibtmux [source] ¶

classlibtmux [source] ¶

class LibTmux::Server

Connects to an existing endpoint. Closing retires clients, never the daemon.

In other ports A tmux server

• Python libtmux.Server
• Lua libtmux.Server
• TypeScript server.Server
• Rust server.Server
• Go tmux.Server
• Java io.github.libtmux.Server.Server
• .NET LibTmux.Server
• C++ libtmux::Server
• Swift Server

Members

• list_sessions method Behavior: Live acquisition.
• list_windows method Behavior: Live acquisition.
• list_panes method Behavior: Live acquisition.
• list_clients method Behavior: Live acquisition.
• list_buffers method Behavior: Buffers.
• snapshot method Behavior: Snapshot acquisition.
• search_panes method Behavior: Source query execution.
• new_session method Behavior: Creation.
• source_file method Behavior: Source files.
• kill method Behavior: Killing daemons.
• options method Behavior: Options and hooks.
• hooks method Behavior: Options and hooks.
• write_buffer method Behavior: Buffers.
• environment method Behavior: Environment.
• read_buffer method Behavior: Buffers.
• delete_buffer method Behavior: Buffers.
• run method Raw tmux arguments retain tmux's separators and format semantics.
• set_environment method Behavior: Environment.
• unset_environment method Behavior: Environment.
• wait_for method Retiring the client cannot remove a dispatched waiter from tmux's queue.
• session method Behavior: Live handles.
• window method Behavior: Live handles.
• pane method Behavior: Live handles.
• attach method Blocks until the owned interactive client exits. The caller supplies and retains its TTY. Cancellation detaches this client, not pane commands.
• close method Behavior: Closing bindings.
• diagnostics method Returns a frozen local snapshot, including after close. Slots are admitted requests; control connections are retained registrations, not OS clients.
• display method Formats are intentionally executable tmux formats, not literal text.
• endpoint method Returns the value of attribute endpoint.
• explain_panes method Behavior: Source query plans.
• list_window_links method Behavior: Live acquisition.
• new method Behavior: Borrowed bindings.
• open method Behavior: Borrowed bindings.
• open_control method Behavior: Control connections.
• owned? method Behavior: Borrowed bindings.
• run_group method One nontransactional tmux command group, with literal arguments per command.
• start method Starts a foreground daemon on a new private endpoint. Close owns its exit. No session is created; the default config is empty. Startup blocks.
• switch_client method Resolves the literal selector at dispatch; it is not a client reference.
• window_link method Behavior: Live handles.