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.stop/1

Requests closure of the pinned epoch through reserved capacity.

Source and package
Qualified name
LibTmux.Operation.stop/1
Module
LibTmux
Declared in
Operation
Package
libtmux
Source
lib/libtmux/operation.ex
stop(operation) @spec stop(t()) :: :ok | {:error, LibTmux.Error.t()}

Description#

Returns :ok for an already wire-retired operation or an accepted closure request, and {:error, error} otherwise. Closure can affect sibling work; success does not prove retirement or change the canonical result. A stale handle cannot revoke a replacement epoch.

See the worked example.

Parameters

Discussed in Read values, execute explicitly

Esc

Type to search.

Reference preview Open reference