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:next-event

Wait for an owned event/:READY or NIL/:TIMEOUT on this connection. TIMEOUT is nonnegative real seconds or NIL; zero polls. :OUTPUT has :PANE, :AGE, :EXTENDED-P and :DATA octets, preserving invalid UTF-8. :NOTIFICATION contains a raw line without LF in :DATA, preserving unknown labels and bytes. Native %exit is a notification; transport end is reported independently. Unsolicited :REPLY also has :FAILED-P. :GAP reports :EVENTS and :BYTES dropped from the bounded queue. An oversized new event reports loss without discarding retained smaller events. Local loss does not pause tmux. Native pause/continue notices remain raw notifications and are distinct from local :GAP delivery. :END follows retained events, with :REASON, :EXIT-CODE, :DIAGNOSTICS bytes, :WIRE-TAIL bytes and :CAUSE. After end, repeated reads return end immediately. Causes retain condition identity. No application callback executes in the reader.

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

Public owner: libtmux.control

Parameters

Guides#

Pages that discuss next-event.

Esc

Type to search.

Reference previewOpen reference