Core LibraryunreleasedAPI Reference

Choose documentation 2

latest

Current version

latest
English

Unreleased libtmux has not been released. Its API may change during development. This site's structure and URLs may change too.

module libtmux-ocaml latest

Libtmux_eio

Concurrent Linux tmux clients using the application's Eio scheduler.

Source and package
Qualified name
Libtmux_eio
Package
libtmux-eio
Source
eio/libtmux_eio.mli
module Libtmux_eio

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 streaming guide demonstrates application-owned switches, cancellation and continuity gaps.

Members7#

Common operations2#

  • Client module An explicit generation-bound connection. Applications retain ownership of the endpoint choice and resource lifetime.
  • Workspace module Apply workspace plans through Eio while retaining journals across caller cancellation. Handles belong to the creating domain; the application owns the scheduler and switch.

Other members5#

  • Cleanup module Domain-owned cleanup diagnostics shared with the blocking backend. Supply a report before setup to inspect secondary failures after native cancellation. No scheduler is needed to inspect a report.
  • Operation module A retained admitted command. A cancelled waiter does not erase its eventual success, failure or uncertainty.
  • Rendered module
  • 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.
Esc

Type to search.

Reference previewOpen reference