Core LibraryunreleasedAPI Reference

Choose documentation 2

latest

Current version

latest
English

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

function libtmux-lisp latest

libtmux.control:open-connection

Attach a separate owned control connection to a captured SESSION. CLIENT supplies the core endpoint and authority. Startup preflights the target and requires the live daemon to be >=3.8. TIMEOUT bounds startup admission and supervised execution; platform preparation and cleanup add caller wall time. REQUEST-LIMIT includes active and queued work. Events drop oldest entries at EVENT-LIMIT or EVENT-BYTE-LIMIT and report loss. REPLY-BYTE-LIMIT bounds each request's retained output; overflow closes the connection with a cause. This call blocks until ready or failed. All limits must be positive integers except the nonnegative real TIMEOUT. No daemon is started or terminated. Attachment preserves the stored session environment; native attach hooks and server lifecycle policies still apply. Readiness checks the observed daemon witness after attachment, so a refused candidate may have appeared briefly.

Source and package
Qualified name
libtmux.control:open-connection
Declared in
libtmux.control
Package
libtmux/control
Source
src/control.lisp
(open-connection client session &key (timeout 30) (request-limit 16) (event-limit 256) (event-byte-limit 4194304) (reply-byte-limit 1048576))

Public owner: libtmux.control

Esc

Type to search.

Reference previewOpen reference