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_unix.Subscription

Bounded future-byte observation with Data/Gap/End and local cursors. Polling is local; waiting and admission belong to the backend.

Source and package
Qualified name
Libtmux_unix.Subscription
Declared in
Libtmux_unix
Package
libtmux-unix
Source
unix/libtmux_unix.mli
module Subscription

Public owner: Libtmux_unix

Members5#

  • close function End an active subscription with Cancelled and discard pending data. Preserve an already ended subscription's terminal reason. Release and reap an unused lane; later calls retain cleanup failures. Does not stop the daemon. poll can still read the terminal event.
  • next function Pump all subscription lanes until one event is available. Default deadline is one second. None follows a consumed End. A deadline keeps the subscription active; cancellation closes it and raises Cancelled.
  • poll function Remove a queued event without I/O. Owning domain only, including after client closure. None means no queued event, not proof of continuity.
  • t typealias
  • wait_for_bytes function Consume future bytes until the nonempty pattern matches, including across Data boundaries. Maximum pattern: 64 KiB. Return the cursor at the match's end within its consumed event. Gaps stop matching; no rendered or earlier output is searched. Timeout leaves the subscription active.
Esc

Type to search.

Reference previewOpen reference