Core LibraryunreleasedAPI Reference

Choose documentation 1

latest

Current version

latest
English

Unreleased libtmux_erlang has not been released. Its API may change during development. This site's structure and URLs may change too.

function libtmux-erlang latest

tmux_operation:cancel/1

Request cancellation using this handle. Any holder can cancel; only the owner can transfer ownership. Queued work can be cancelled before submission; possibly sent work retires its client and can retain an unknown tmux outcome. Use await/2 for the result and cleanup proof. Never infer rollback or automatically retry a mutation from cancellation alone. already_completed means a response exists; it does not establish complete cleanup.

Source and package
Qualified name
tmux_operation:cancel/1
Declared in
tmux_operation
Package
libtmux_erlang
Source
apps/libtmux_erlang/src/tmux_operation.erl
cancel(Operation) -spec cancel(t()) -> {ok, cancelled_before_send | cancel_requested | already_completed} | {error, map()}.
Parameters
Esc

Type to search.

Reference previewOpen reference