OCaml API

module libtmux-ocaml latest

Libtmux_unix

Blocking Linux tmux clients with explicit scoped cancellation.

Source and package

module Libtmux_unix module libtmux-unix [source] ¶: Description#

Client methods perform I/O unless documented otherwise. Captured Libtmux.Snapshot observations and retained Operation.inspect remain local. Clients belong to the connecting domain. Closure releases their owned resources; tmux applies its configured daemon lifetime.
See Client for acquisition and commands, Operation for cancellation outcomes, and Subscription for bounded future output. The control guide explains binding, completion and recovery.

Members8#

Cancellation module
Client module An explicit generation-bound connection. Applications retain ownership of the endpoint choice and resource lifetime.
Workspace module Apply validated plans with blocking I/O and scoped cancellation tokens. Execution handles retain journals and borrow existing clients; bootstrap handles own their newly bound clients without owning the daemon.

Cleanup module Retained failures from releasing processes and descriptors. Reports belong to their creating domain and remain readable after client closure. They preserve secondary failures without replacing a primary exception or cancellation.
Operation module Retained outcomes remain inspectable after client closure, on the owning domain. Keep the handle from Client.submit before Client.await, then read Operation.inspect. The hook recovery walkthrough shows creation evidence after a later hook failure.
Rendered module Blocking native Linux transport. No Eio scheduler is started.
Subscription module Bounded future-byte observation with Data/Gap/End and local cursors. Polling is local; waiting and admission belong to the backend.
Terminal module Interactive attachment using borrowed application streams. This utility addresses the current daemon explicitly and does not reuse captured targets.