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:reconnect

Retire CONNECTION and return a fresh connection and complete snapshot. Use the original core client and exact session ID. The client must remain open in the original generation. Explicitly supplied limits must be positive integers; omitted queue/reply limits inherit the old connection. TIMEOUT is nonnegative real seconds shared across preflight, retirement, recapture and startup; preparation and cleanup can add wall time. Capture output shares the core client's output budget. Concurrent core work signals LIBTMUX:CLIENT-BUSY. Preflight refusal leaves a live old connection alone. After successful close, renew the core generation even if later work fails. Every earlier core capture from that client becomes stale for operations, while local data remains usable. The returned snapshot precedes new attachment; it does not include that new frontend. A closing/closed old resource remains reconnectable with valid origin. Old requests/results/events stay on the retired resource. Pending work is closed, never replayed; dispatched effects can remain uncertain. Other separately owned control resources remain independent. No event continuity or replay is implied. The CLOSE-CONNECTION generic runs on the caller thread; its failures are retained. CONNECTION-STALE refuses changed origin/session/daemon. Old cleanup failures retain the old resource; startup failures retain the new candidate through CONNECTION-START-FAILED. After failed cutover, acquire/select and open anew. Use WITH-RECONNECTION or close the returned resource explicitly.

Source and package
Qualified name
libtmux.control:reconnect
Declared in
libtmux.control
Package
libtmux/control
Source
src/control.lisp
(reconnect connection &key (timeout 30) (request-limit nil request-limit-p) (event-limit nil event-limit-p) (event-byte-limit nil event-byte-limit-p) (reply-byte-limit nil reply-byte-limit-p))

Public owner: libtmux.control

Esc

Type to search.

Reference previewOpen reference