libtmux Reference MCP Search
On this page

tmux.PaneObservation

View as Markdown

Module
tmux
Package
github.com/libtmux/libtmux-go/tmux
Source
tmux/control_observation.go
struct tmux.PaneObservation
struct [source]
struct [source]
struct tmux.PaneObservation

PaneObservation is one visible pane baseline followed by the exact control notification stream after that baseline. That stream is the observation's whole control connection, so a caller wanting only this pane's output selects it by identifier. Create one with Pane.OpenObservation and close it when finished. Copies share notification reader ownership, terminal loss, and client lifetime; closing one closes them all.

5 declared, 0 inherited

Members

  • Baseline method Baseline returns an owned copy of the pane's visible text at the observation boundary.
  • Close method Close stops the dedicated control client. It is safe to call more than once.
  • CloseContext method CloseContext starts idempotent observation shutdown and waits within ctx.
  • NextNotification method NextNotification returns the next notification strictly after the pane baseline, from the whole connection rather than this pane alone. Notifications queued before that boundary are discarded. Concurrent calls are serialized. Caller context errors and ControlNotificationError affect only one call. Explicit close returns an error matching os.ErrClosed.
  • PaneID method PaneID returns the pane selected at the observation boundary.
Esc

Type to search.