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

ServerSnapshot

One tmux hierarchy, as it was at one moment.

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

Description#

Every question below is answered from what was captured, so traversing a snapshot issues no commands and cannot observe a half-changed server. It claims a moment rather than current truth: tmux offers no transaction across separate listings, and pretending otherwise would be a promise this cannot keep.

Members14#

Collections and queries4#

  • sessions method Every session, in tmux's order.
  • windows method Every winlink, in tmux's order, including a window linked into more than one session twice.
  • panes method Every pane, in tmux's order.
  • clients method Every attached client.

Other members10#

  • capturedAt method When this capture was taken.
  • of method Assembles a capture tied to the live tmux process and version that produced it, with no start time: a handle made from it is fenced by the process id alone.
  • panesOf method The panes under one winlink, in order. Empty when the capture never saw that winlink.
  • serverPid method The tmux process that produced this capture, absent when assembled from detached state.
  • serverStartTime method When the tmux process that produced this capture started, in seconds since the epoch, as #{start_time} reports it. Absent when the capture was assembled without it.
  • serverVersion method The tmux version that produced this capture, absent when assembled from detached state.
  • session method The session with this id, if the capture saw it.
  • toString method
  • window method The winlink at this exact position, if the capture saw it.
  • windowsOf method The winlinks in one session, in order. Empty when the capture never saw that session.
Esc

Type to search.

Reference previewOpen reference