Core LibraryalphaAPI Reference

Choose documentation 1

latest

Current version

latest
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

function libtmux-elixir latest

Operation.await/2

Waits for a canonical result under one positive millisecond timeout.

Source and package
Qualified name
LibTmux.Operation.await/2
Module
LibTmux
Declared in
Operation
Package
libtmux
Source
lib/libtmux/operation.ex
await(operation, options \\ []) @spec await(t(), [option()]) :: {:ok, result()} | {:error, LibTmux.Error.t()}

Description#

The default is 5000ms. Every call claims an independent bounded waiter slot, including terminal operations; use result/1 for immediate inspection. Completed waiter copies survive record reclamation until this caller reads them. Timeout, overload and caller death affect only this waiter.

See the worked example.

Parameters

Discussed in Read values, execute explicitly · Execution ownership

Esc

Type to search.

Reference preview Open reference