libtmux Reference MCP Search
On this page

libtmux::Server::control

View as Markdown

Module
libtmux
Declared in
Server
Package
libtmux-cxx
Source
include/libtmux/server.hpp
control ( session : std::string_view ) expected< Connection, ProtocolError >
methodreadonly [source]
methodreadonly [source]
control

Open a control-mode connection to one session.

This is the streaming half of the transport: a control connection stays open, exposes guarded reply blocks in wire order, and delivers events outside those blocks. The synchronous surface above is unaffected — a caller who never opens one never pays for it. A guarded block is not a final result for commands whose work tmux completes asynchronously.

Fails with ProtocolError , not CommandFailure , because that is what the Connection it returns speaks: an error type here that the value's own surface does not use would make the doorway disagree with the room.

Discussed in Control mode vs one-shot

0 declared, 0 inherited

Esc

Type to search.