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

Control.close/2

Requests closure and waits for proven retirement of the pinned epoch.

Source and package
Qualified name
LibTmux.Control.close/2
Module
LibTmux
Declared in
Control
Package
libtmux
Source
lib/libtmux/control.ex
close(control, options \\ []) @spec close(t(), [call_option()]) :: :ok | {:error, LibTmux.Error.t()}

Description#

timeout defaults to 5000ms. The original budget includes validation and retirement waiting. Closure still happens if the bounded metadata wait cannot be admitted. Timeout, overload or lost ownership reports unknown certainty; it never proves cleanup. :ok requires known native and actor retirement.

The connection supervisor and retained records remain available for explicit reconnect and inspection. This does not stop the supervisor or roll back sibling effects.

See the worked example.

Parameters

Discussed in Read values, execute explicitly · Execution ownership

Esc

Type to search.

Reference preview Open reference