ControlClient.subscribeOutput
Subscribes to terminal output tmux pushes. Retains at most 16 MiB of unescaped payload, as well as the event limit.
Source and package
- Qualified name
-
io.github .libtmux .control .Control Client. subscribe Output - Package
- io.github.libtmux.control
- Declared in
ControlClient- Distribution
- io.github.libtmux:libtmux
- Source
- libtmux/src/main/java/io/github/libtmux/control/ControlClient.java
- @Operation(Kind
.STREAM ) public EventSubscription <PaneOutput > subscribeOutput( int capacity)@Operation(Kind.STREAM ) public EventSubscription <PaneOutput > subscribeOutput( int capacity, long maxBytes ) -
- Parameters
-
-
capacity(int) # – how many values this subscriber can retain before its oldest value is dropped forsubscribeOutput(capacity) -
capacity(int) # – maximum number of queued events forsubscribeOutput(capacity, maxBytes) -
maxBytes(long) # – maximum queued payload bytes, before text rendering forsubscribeOutput(capacity, maxBytes)
-
- Returns
-
a pull subscription owned by the caller
- Raises
-
-
Illegal
Argument – ifException capacityis not positive forsubscribeOutput(capacity) -
Illegal
State – if the client has endedException -
Illegal
Argument – if either bound is not positive forException subscribeOutput(capacity, maxBytes)
-