Core LibraryalphaAPI Reference

Choose documentation 1

latest

Current version

latest
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

module libtmux-elixir latest

Capture

Builds a bounded one-shot observation of one existing Linux tmux server.

Source and package
Qualified name
LibTmux.Capture
Module
LibTmux
Package
libtmux
Source
lib/libtmux/capture.ex
LibTmux.Capture

Description#

Capture checks topology and OS server identity before and after field reads. Attempts share the original deadline and work budgets; attempts defaults to 2 and accepts 1–3. Only inconsistent topology or disappearing read targets retry. Decoding and coverage errors remain visible.

Defaults: 1024 contextual entity rows, 512 commands, 8 MiB total response bytes, 64 KiB per response and 5000 ms. Exceeding a ceiling returns an error, never a partial success. Linked rows count against the work limit. Free-form fields share one encoded response per physical entity, including its framing overhead. One successful attempt uses 10 + S + W + P commands for S sessions, W physical windows and P panes. Capture adds no control attachment. Hooks configured on list commands can still have effects; retries do not replay application mutations.

Members2#

  • fetch/2 function Performs bounded capture through an explicit server descriptor.
  • option/0: option() :: {:timeout, pos_integer()} | {:deadline, LibTmux.Deadline.t()} | {:attempts, 1..3} | {:max_entities | :max_commands | :max_bytes | :max_response_bytes, pos_integer()} typealias Capture-wide budgets shared by all attempts and reads.
Esc

Type to search.

Reference preview Open reference