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.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_eio.Subscription
Declared in
Libtmux_eio
Package
libtmux-eio
Source
eio/libtmux_eio.mli
module Subscription

Public owner: Libtmux_eio

Members5#

Common operations1#

  • wait_for_bytes function Consume future observed bytes through a match, with a maximum 64 KiB nonempty pattern. Match across Data boundaries and return its end cursor. Gaps end matching. This searches neither rendered text nor history. A deadline leaves the subscription active; cancellation closes it.

Other members4#

  • close function End an active subscription with Cancelled and discard pending data. Preserve an already ended subscription's terminal reason. Concurrent calls join the same cleanup, including reaping a lane when it becomes unused; later calls retain cleanup failures. Borrowed clients and the daemon remain alive. poll can still read the terminal event.
  • next function Await one event, defaulting to a one-second deadline. None follows a consumed End. A deadline keeps the subscription active. Eio cancellation closes it, releases its lane when unused, and propagates.
  • poll function Remove a queued event without I/O, on the owning domain.
  • t typealias
Esc

Type to search.

Reference previewOpen reference