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:await-request

Wait for owned result/:READY, or return NIL/:TIMEOUT without cancelling. TIMEOUT is nonnegative real seconds or NIL for an unbounded wait. Zero polls. The result plist contains :STATUS, :OUTPUT bytes, :WIRE-TAIL bytes, :TRUNCATED-P, :EFFECT, :DISPATCHED-P, :REASON and :REPLY-COUNT. Wire tail is unterminated protocol data, not decoded output. Positive stdin progress makes DISPATCHED-P true conservatively, even for an incomplete line. A dispatched failed/cancelled/timed-out/closed request may have effects; never infer rollback. COMPLETED means the command queue reached its marker, not application readiness. Only framed replies enter OUTPUT; unframed lines remain notification events. Repeated awaits return fresh byte storage. No exception hides a terminal result.

Source and package
Qualified name
libtmux.control:await-request
Declared in
libtmux.control
Package
libtmux/control
Source
src/control.lisp
(await-request request &key (timeout 30))

Public owner: libtmux.control

Parameters

Guides#

Pages that discuss await-request.

Esc

Type to search.

Reference previewOpen reference