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.Operation

A retained admitted command. A cancelled waiter does not erase its eventual success, failure or uncertainty.

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

Public owner: Libtmux_eio

Members7#

  • await_stage function Wait for the named stage or a terminal state. Acknowledgement does not establish completion. Cancelling this observer leaves the operation alone.
  • cancel function Remove unsent work. A written request remains owned and drained by the client.
  • cleanup_receipt struct created retains IDs reported before a later hook or completion failure. It does not prove those resources still exist or authorize retry. When the daemon watcher retires an in-flight operation, cause retains Libtmux.Error.Disconnected. Idle-reader failures also retain their library cause instead of becoming an explicit client-close reason.
  • id function
  • inspect function Read without I/O, including after client closure. Owning domain only.
  • state enum
  • t typealias
Esc

Type to search.

Reference previewOpen reference