LibTmux.Server

class LibTmux.Server

class [source] ¶

class [source] ¶

class LibTmux.Server

Represents an immutable server handle and snapshot.

Thread-safe: the handle is immutable once constructed and may be shared freely, including as a singleton. Every mutating call answers a new handle rather than changing this one.

Discussed in .NET workspace internals , .NET workspace builder examples , .NET workspace builder API

In other ports A tmux server

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

Members

• Sessions property Gets the sessions this handle captured.
• Windows property Gets the windows this handle captured, across every session.
• Panes property Gets the panes this handle captured, across every window.
• Clients property Gets the clients this handle captured.
• GetCommandsAsync method Reads the commands this tmux knows.
• Buffers property Gets the paste buffers of this server.
• CaptureSnapshotAsync method Reads the server and answers a handle carrying what it found.
• SearchPanesAsync method Runs a tmux-side filter over every pane.
• SearchSessionsAsync method Runs a tmux-side filter over every session.
• SearchWindowsAsync method Runs a tmux-side filter over every window.
• CreateSessionAsync method Creates a session.
• SourceFileAsync method Reads a tmux configuration file.
• KillAsync method Stops the tmux server.
• Options property Gets the options of this server.
• Hooks property Gets the hooks of this server.
• IsAliveAsync method Reports whether a tmux server is answering.
• Environment property Gets the environment new sessions inherit from.
• RunShellAsync method Runs a shell command and reports what it printed.
• HasSessionAsync method Reports whether a session exists.
• WaitForAsync method Waits on, signals, locks, or unlocks a tmux channel.
• AttachSessionAsync method Attaches a client to a session on this server.
• IfShellAsync method Runs one tmux command or another depending on a shell command.
• GetPromptHistoryAsync method Reads what has been typed at command prompts.
• ClearPromptHistoryAsync method Forgets what has been typed at command prompts.
• LockAsync method Locks every client attached to this server.
• ThrowIfDeadAsync method Throws unless a tmux server is answering.
• StartServerAsync method Starts the tmux server without creating a session.
• Version property Gets the captured tmux version.
• GetSessionAsync method Reads one session by identifier, throwing when it is absent.
• GetWindowAsync method Reads one window by identifier, throwing when it is absent.
• GetPaneAsync method Reads one pane by identifier, throwing when it is absent.
• GetMessagesAsync method Reads what the server has been logging.
• ShowCommandPromptAsync method Asks a client for input and runs a command with the answer.
• DisplayMessageAsync method Shows a message on a client.
• DetachClientAsync method Detaches one client.
• KillSessionAsync method Stops one session.
• Chain method Begins a chain that runs its commands in one tmux invocation.
• FromEnvironment method Returns the server whose pane this process was spawned in.
• GetAttachedSessionsAsync method Reads every session with at least one attached client.
• ConfirmBeforeAsync method Asks a client to confirm before running a command.
• DetachAllClientsAsync method Detaches every client except one.
• LockClientAsync method Locks one client.
• SuspendClientAsync method Suspends one client.
• RefreshClientAsync method Redraws one client.
• SwitchClientAsync method Switches the caller's client to another session.
• EnterControlModeAsync method Starts a tmux control client and keeps it running.
• GetSessionsAsync method Reads every session on this server.
• OpenWaitChannel method Opens a wait on a channel that survives a timed attempt.
• ConfigureAccessAsync method Grants or withdraws another user's access to this server.
• ConnectAsync method Connects to a configured tmux endpoint.
• ConnectionOptions property Gets the connection options.
• CreateOwnedAsync method Starts a server and takes ownership of it.
• CreateOwnedSessionAsync method Creates a session and takes ownership of it.
• Equals method
• ExecuteCommandAsync method Executes one raw tmux command.
• FindPaneAsync method Reads one pane by identifier, returning null when it is absent.
• FindSessionAsync method Reads one session by identifier, returning null when it is absent.
• FindWindowAsync method Reads one window by identifier, returning null when it is absent.
• Generation property Gets the materialized server generation.
• GetClientsAsync method Reads the clients attached to this server.
• GetHashCode method
• GetPanesAsync method Reads every pane on this server.
• GetWindowsAsync method Reads every window on this server.
• IsMaterialized property Gets whether this handle has discovered a live server.
• Keys property Gets the key bindings of this server.
• Open method Opens an unmaterialized server connection handle.
• ShowMenuAsync method Shows a menu on a client.