Core Library0.xAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

class libtmux-java latest

SnapshotCapture

Reads a whole tmux server into one snapshot.

Source and package
Qualified name
io.github.libtmux.SnapshotCapture
Package
io.github.libtmux
Distribution
io.github.libtmux:libtmux
Source
libtmux/src/main/java/io/github/libtmux/SnapshotCapture.java
class io.github.libtmux.SnapshotCapture

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.

Two commands: who the server is, then the listings as one group fenced against both halves of that answer, its pid and its version. tmux runs a group in the server, so rows cannot come from two of them, and a server that is not the one probed is refused before a listing runs rather than detected afterwards. Retrying is Server#snapshot()'s decision, not this one's.

Members8#

  • attempt method One attempt, empty when the server was replaced under it.
  • oneSession method One session, its windows, and its panes. Empty when that session is absent. Other sessions are not read.
  • process method Reads process identity and version together so neither can come from a different server.
  • ServerProcess class The server a capture reads, named by its process and when that process started.
  • sessionsHolding method The sessions holding this pane, with their windows and panes, in one fenced call. Empty when no session holds it.
  • sessionsNamed method The sessions stored under any name tmux may keep for this one, read in one fenced call, and an empty capture when there are none. Empty when a candidate cannot sit inside a format, and the caller reads the whole server instead.
  • sessionsWhere method The sessions holding a row that format selects in this listing, read in full in one fenced call, and a capture holding nothing when none does.
  • SnapshotCapture method
Esc

Type to search.

Reference previewOpen reference