Client.subscribe
Acquire verified coverage of the pane's observed session/window. Choose the least session ID unless explicitly supplied. Reuse one lane per session. Defaults: 1 MiB and 1024 queued events per subscriber; at most 16 subscribers and eight client lanes including commands. Reserve payload against the shared 32 MiB budget before admission.
Source and package
- Qualified name
-
Libtmux_unix .Client. subscribe - Module
- Libtmux_unix
- Declared in
Client- Package
- libtmux-unix
- Source
- unix/libtmux_unix.mli
- val subscribe : ?session:Libtmux
.Session -> ?capacity_bytes:int -> ?capacity_events:int -> t -> Libtmux.target .Pane -> (Subscription.t .t , Libtmux.Error ) result.t -
Public owner:
Libtmux_unixDescription#
Queue capacities remain reserved while empty. Captures and reads need additional scratch space; their admission can return
Libtmux.Error.Capacitybelow the subscriber-count limit. See the shared capacity guide for the combined reservations and process slots.Data starts after admission's marker. Layout/membership changes end continuity conservatively. Overflow emits Gap then End, without blocking another subscriber. Blocking delivery advances during Subscription.next. There is no snapshot/history barrier or automatic recovery.
- Parameters
-
-
capacity_bytes? (int) # -
capacity_events? (int) #
tmux command#
The tmux commands behind subscribe.
display-message refresh-client (when opening a new stream lane) tmux C API#
The C declarations in tmux that implement these commands.