Julia

Choose a port 15

Scripting & web

PythonNo matching page

RubyNo matching page

LuaNo matching page

TypeScriptNo matching page

Compiled & native

RustNo matching page

GoNo matching page

C++No matching page

SwiftNo matching page

JVM

JavaNo matching page

KotlinNo matching page

ScalaNo matching page

.NET

C#No matching page

F#No matching page

PowerShellNo matching page

tmux

Auto Light Dark

Core LibraryAPI Reference

Choose documentation 3

latest

Current version

English

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

Julia API

struct LibTmux.jl latest

ObservationStream

Module LibTmux

A single-consumer, bounded event iterator. Use take!(stream; timeout, cancel) for an explicit deadline or for event in stream for connection-lifetime iteration. Close explicitly or use the producer's do-block form for deterministic cleanup. An unreachable stream is retired eventually; GC is not a cleanup deadline. Each fan-out subscriber owns its byte copies; overflow ends only that subscription.

Source and package

Module: LibTmux
Package: LibTmux
Source: src/observation.jl

LibTmux.ObservationStream( connection::LibTmux.ControlConnection, kind::Symbol, pane::Union{Nothing, LibTmux.PaneRef}, names::Tuple, subscription::Union{Nothing, String}, field::Union{Nothing, String}, queue::Vector{LibTmux.ObservationEvent}, bytes::Int64, capacity::Int64, max_bytes::Int64, cursor::LibTmux.ObservationCursor, consumer::Union{Nothing, Task}, open::Bool, error::Union{Nothing, Exception}, cleanup_done::Bool, reserved::Bool ) LibTmux.ObservationStream( connection, kind, pane, names, subscription, field, queue, bytes, capacity, max_bytes, cursor, consumer, open, error, cleanup_done, reserved ) struct LibTmux [source] ¶

Methods#

LibTmux.ObservationStream( connection::LibTmux.ControlConnection, kind::Symbol, pane::Union{Nothing, LibTmux.PaneRef}, names::Tuple, subscription::Union{Nothing, String}, field::Union{Nothing, String}, queue::Vector{LibTmux.ObservationEvent}, bytes::Int64, capacity::Int64, max_bytes::Int64, cursor::LibTmux.ObservationCursor, consumer::Union{Nothing, Task}, open::Bool, error::Union{Nothing, Exception}, cleanup_done::Bool, reserved::Bool )[source]#

LibTmux.ObservationStream( connection, kind, pane, names, subscription, field, queue, bytes, capacity, max_bytes, cursor, consumer, open, error, cleanup_done, reserved )[source]#

Parameters

connection ( LibTmux.ControlConnection ) (for ObservationStream(connection, kind, pane, names, subscription, field, queue, bytes, capacity, max_bytes, cursor, consumer, open, error, cleanup_done, reserved) [overload 1]) #
kind ( Symbol ) (for ObservationStream(connection, kind, pane, names, subscription, field, queue, bytes, capacity, max_bytes, cursor, consumer, open, error, cleanup_done, reserved) [overload 1]) #
pane ( Union{Nothing, LibTmux.PaneRef} ) (for ObservationStream(connection, kind, pane, names, subscription, field, queue, bytes, capacity, max_bytes, cursor, consumer, open, error, cleanup_done, reserved) [overload 1]) #
names ( Tuple ) (for ObservationStream(connection, kind, pane, names, subscription, field, queue, bytes, capacity, max_bytes, cursor, consumer, open, error, cleanup_done, reserved) [overload 1]) #
subscription ( Union{Nothing, String} ) (for ObservationStream(connection, kind, pane, names, subscription, field, queue, bytes, capacity, max_bytes, cursor, consumer, open, error, cleanup_done, reserved) [overload 1]) #
field ( Union{Nothing, String} ) (for ObservationStream(connection, kind, pane, names, subscription, field, queue, bytes, capacity, max_bytes, cursor, consumer, open, error, cleanup_done, reserved) [overload 1]) #
queue ( Base.Vector{LibTmux.ObservationEvent} ) (for ObservationStream(connection, kind, pane, names, subscription, field, queue, bytes, capacity, max_bytes, cursor, consumer, open, error, cleanup_done, reserved) [overload 1]) #
bytes ( Int64 ) (for ObservationStream(connection, kind, pane, names, subscription, field, queue, bytes, capacity, max_bytes, cursor, consumer, open, error, cleanup_done, reserved) [overload 1]) #
capacity ( Int64 ) (for ObservationStream(connection, kind, pane, names, subscription, field, queue, bytes, capacity, max_bytes, cursor, consumer, open, error, cleanup_done, reserved) [overload 1]) #
max_bytes ( Int64 ) (for ObservationStream(connection, kind, pane, names, subscription, field, queue, bytes, capacity, max_bytes, cursor, consumer, open, error, cleanup_done, reserved) [overload 1]) #
cursor ( LibTmux.ObservationCursor ) (for ObservationStream(connection, kind, pane, names, subscription, field, queue, bytes, capacity, max_bytes, cursor, consumer, open, error, cleanup_done, reserved) [overload 1]) #
consumer ( Union{Nothing, Task} ) (for ObservationStream(connection, kind, pane, names, subscription, field, queue, bytes, capacity, max_bytes, cursor, consumer, open, error, cleanup_done, reserved) [overload 1]) #
open ( Bool ) (for ObservationStream(connection, kind, pane, names, subscription, field, queue, bytes, capacity, max_bytes, cursor, consumer, open, error, cleanup_done, reserved) [overload 1]) #
error ( Union{Nothing, Exception} ) (for ObservationStream(connection, kind, pane, names, subscription, field, queue, bytes, capacity, max_bytes, cursor, consumer, open, error, cleanup_done, reserved) [overload 1]) #
cleanup_done ( Bool ) (for ObservationStream(connection, kind, pane, names, subscription, field, queue, bytes, capacity, max_bytes, cursor, consumer, open, error, cleanup_done, reserved) [overload 1]) #
reserved ( Bool ) (for ObservationStream(connection, kind, pane, names, subscription, field, queue, bytes, capacity, max_bytes, cursor, consumer, open, error, cleanup_done, reserved) [overload 1]) #
connection ( Any ) (for ObservationStream(connection, kind, pane, names, subscription, field, queue, bytes, capacity, max_bytes, cursor, consumer, open, error, cleanup_done, reserved) [overload 2]) #
kind ( Any ) (for ObservationStream(connection, kind, pane, names, subscription, field, queue, bytes, capacity, max_bytes, cursor, consumer, open, error, cleanup_done, reserved) [overload 2]) #
pane ( Any ) (for ObservationStream(connection, kind, pane, names, subscription, field, queue, bytes, capacity, max_bytes, cursor, consumer, open, error, cleanup_done, reserved) [overload 2]) #
names ( Any ) (for ObservationStream(connection, kind, pane, names, subscription, field, queue, bytes, capacity, max_bytes, cursor, consumer, open, error, cleanup_done, reserved) [overload 2]) #
subscription ( Any ) (for ObservationStream(connection, kind, pane, names, subscription, field, queue, bytes, capacity, max_bytes, cursor, consumer, open, error, cleanup_done, reserved) [overload 2]) #
field ( Any ) (for ObservationStream(connection, kind, pane, names, subscription, field, queue, bytes, capacity, max_bytes, cursor, consumer, open, error, cleanup_done, reserved) [overload 2]) #
queue ( Any ) (for ObservationStream(connection, kind, pane, names, subscription, field, queue, bytes, capacity, max_bytes, cursor, consumer, open, error, cleanup_done, reserved) [overload 2]) #
bytes ( Any ) (for ObservationStream(connection, kind, pane, names, subscription, field, queue, bytes, capacity, max_bytes, cursor, consumer, open, error, cleanup_done, reserved) [overload 2]) #
capacity ( Any ) (for ObservationStream(connection, kind, pane, names, subscription, field, queue, bytes, capacity, max_bytes, cursor, consumer, open, error, cleanup_done, reserved) [overload 2]) #
max_bytes ( Any ) (for ObservationStream(connection, kind, pane, names, subscription, field, queue, bytes, capacity, max_bytes, cursor, consumer, open, error, cleanup_done, reserved) [overload 2]) #
cursor ( Any ) (for ObservationStream(connection, kind, pane, names, subscription, field, queue, bytes, capacity, max_bytes, cursor, consumer, open, error, cleanup_done, reserved) [overload 2]) #
consumer ( Any ) (for ObservationStream(connection, kind, pane, names, subscription, field, queue, bytes, capacity, max_bytes, cursor, consumer, open, error, cleanup_done, reserved) [overload 2]) #
open ( Any ) (for ObservationStream(connection, kind, pane, names, subscription, field, queue, bytes, capacity, max_bytes, cursor, consumer, open, error, cleanup_done, reserved) [overload 2]) #
error ( Any ) (for ObservationStream(connection, kind, pane, names, subscription, field, queue, bytes, capacity, max_bytes, cursor, consumer, open, error, cleanup_done, reserved) [overload 2]) #
cleanup_done ( Any ) (for ObservationStream(connection, kind, pane, names, subscription, field, queue, bytes, capacity, max_bytes, cursor, consumer, open, error, cleanup_done, reserved) [overload 2]) #
reserved ( Any ) (for ObservationStream(connection, kind, pane, names, subscription, field, queue, bytes, capacity, max_bytes, cursor, consumer, open, error, cleanup_done, reserved) [overload 2]) #

Reference preview Open reference