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_control:attach/3

Attach to an existing captured session from this exact endpoint origin. Performs I/O and waits for a same-connection identity probe. Uses attach-session with -E rather than creating a session or writing options. Configured hooks may change state; failure does not reverse their effects. The control client affects attached_count. Unexpected hook-generated reply blocks fail attachment and retire the client.

Source and package
Qualified name
tmux_control:attach/3
Declared in
tmux_control
Package
libtmux_erlang
Source
apps/libtmux_erlang/src/tmux_control.erl
attach(Server, Session, Options) -spec attach(tmux_server:t(), tmux_model:session(), attach_options()) -> {ok, t()} | {error, map()}.

Description#

An attachment timeout requests cleanup. If cleanup cannot be proved within its finite deadline, the error includes a control handle for close/1 recovery. The supervised owner remains until native retirement. Close explicitly to observe cleanup, including when the parent endpoint is already closed.

Esc

Type to search.

Reference previewOpen reference