LibTmux.Session

class LibTmux.Session

class [source] ¶

class [source] ¶

class LibTmux.Session

Represents an immutable session 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 Traversal

In other ports A tmux session

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

Members

• Windows property Gets the windows the capture found in this session.
• Panes property Gets the panes the capture found in this session.
• SearchWindowsAsync method Runs a tmux-side filter over this session's windows.
• SearchPanesAsync method Runs a tmux-side filter over this session's panes.
• CreateWindowAsync method Creates a window in this session.
• KillAsync method Stops this session.
• RenameAsync method Renames this session.
• Hooks property Gets the hooks of this session.
• Options property Gets the options of this session.
• Id property Gets the session identifier.
• Name property Gets the session name captured with this handle.
• Attached property Gets whether a client was attached when this session was read.
• Environment property Gets the environment panes created in this session inherit from.
• DetachClientAsync method Detaches every client attached to this session.
• ActiveWindow property Gets the captured active window, or an uncaptured relation.
• ActivePane property Gets the captured active pane, or an uncaptured relation.
• RefreshAsync method Re-reads this session from tmux.
• SelectNextWindowAsync method Selects the next window.
• SelectPreviousWindowAsync method Selects the previous window.
• SelectLastWindowAsync method Selects the window that was last active.
• Server property Gets the server that owns this session.
• SelectWindowAsync method Selects a window in this session.
• FromEnvironmentAsync method Returns the session holding the pane this process runs in.
• LockAsync method Locks this session.
• KillWindowAsync method Stops one window in this session.
• SwitchClientAsync method Switches the current client to this session.
• GetWindowsAsync method Reads this session's windows from tmux.
• AttachAsync method Attaches a client to this session.
• CreateOwnedWindowAsync method Creates a window in this session and takes ownership of it.
• Equals method
• ExecuteCommandAsync method Executes one raw tmux command against this session.
• FindWindowAsync method Reads one of this session's windows by identifier.
• Generation property Gets the server generation captured with this session.
• GetHashCode method
• GetPanesAsync method Reads this session's panes from tmux.
• GetWindowAsync method Reads one window in this session, throwing when it is absent.
• RawFormatFields property Gets the tmux fields captured when this handle materialized.