class libtmux-dotnet latest
Session
Represents an immutable session handle and snapshot.
Source and package
-
Description#
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 Ownership and cleanup , 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 - C++
libtmux::Session - Swift
Session - Kotlin
io.github.libtmux.kotlin.Session - Scala
io.github.libtmux.scaladsl.Session - F# No source-verified F# equivalent is recorded for this operation.
- Python
Members40 members#
Parent objects1 member#
- Server property Gets the server that owns this session.
Collections and queries6 members#
- Windows property Gets the windows the capture found in this session.
- Panes property Gets the panes the capture found in this session.
- GetWindowsAsync method Reads this session's windows from tmux.
- GetPanesAsync method Reads this session's panes from tmux.
- SearchWindowsAsync method Runs a tmux-side filter over this session's windows.
- SearchPanesAsync method Runs a tmux-side filter over this session's panes.
Common operations21 members#
- 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.
- 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.
Other members12 members#
- AttachAsync method Attaches a client to this session.
- CreateOwnedWindowAsync method Creates a window in this session and takes ownership of it.
- CreateWindowWithReceiptAsync method Creates a window and returns its initial pane identity.
- 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.
- GetActivePaneAsync method Reads from tmux the pane this session shows: its current window's active pane.
- GetHashCode method
- GetWindowAsync method Reads one window in this session, throwing when it is absent.
- HoldWaitClientAsync method Keeps the control client that waits on this session's panes use attached until the handle is disposed.
- RawFormatFields property Gets the tmux fields captured when this handle materialized.