Server.snapshot
Captures the whole hierarchy in at most four listings, retrying once if the server is replaced.
Source and package
- Qualified name
-
io.github .libtmux .Server. snapshot - Package
- io.github.libtmux
- Declared in
Server- Distribution
- io.github.libtmux:libtmux
- Source
- libtmux/src/main/java/io/github/libtmux/Server.java
- Other languages
- Perlmethod Erlangfunction PowerShellcmdlet Juliafunction Elixirfunction Haskell Common Lispfunction Python RubyLuaTypeScriptRustmethod GoC# C++ SwiftKotlinScalaOCamlfunction F#function Clojurefunction
-
Description#
One server-wide listing per kind of object, so ordering and membership stay tmux's decision rather than being re-derived from another listing's rows.
A failed read throws, including when no daemon is running. An empty graph means a live server successfully reported no sessions.
- Raises
-
-
Server
Unavailable – if no daemon is runningException -
Lib
Tmux – if a listing otherwise fails or the listings cannot form one valid snapshotException
-
tmux command#
The tmux commands behind snapshot.
list-panes -a server scope, cmd_list_panes_server tmux C API#
The C declarations in tmux that implement these commands.
In other ports#
Capture the tmux hierarchy
| Language | Equivalent |
|---|---|
| Python | no equivalent on Server |
| Ruby | Lib |
| Lua | libtmux |
| PowerShell | Lib Acquires a replacement LibTmux.Server to -Depth (panes by default). Acquisition is not atomic; retained handles do not refresh. |
| Julia | Lib Acquires a new Snapshot over an observation interval. Topology checks do not make it a transaction; earlier snapshots do not refresh. |
| Erlang | tmux Captures a new graph over an observation interval. Retained snapshots never refresh. |
| Elixir | Lib Captures a new graph over an observation interval. A retained Snapshot never refreshes. |
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| Common Lisp | libtmux: fetch-snapshot acquires a new interval observation. Retained snapshots never refresh in place. |
| TypeScript | server |
| Rust | server Fetches the whole hierarchy with list-sessions, list-windows -a and list-panes -a, and stitches the rows by winlink. The three listings are separate commands, so the capture is not an atomic transaction. |
| Go | tmux |
| Clojure | libtmux Acquires a captured graph of persistent values. Retained values do not refresh after mutation or close. |
| Kotlin | io |
| Scala | io |
| C# | Lib |
| F# | Lib Acquires a replacement shared .NET LibTmux.Server to the requested depth. Acquisition is not atomic; retained handles do not refresh. |
| C++ | no equivalent on Server: sessions, windows, panes and clients each take a snapshot of one listing, and Snapshot::take needs the internal detail::Backend, so no public call reads the whole hierarchy at once |
| Swift | Server |
| OCaml | Libtmux Acquires a complete immutable graph over an interval. Earlier observations remain readable without refreshing. |
| Perl | Lib Strict acquisition observes an interval, not an atomic transaction; retained handles do not refresh. |