Server.control
Open a control-mode connection to one session.
Source and package
- Qualified name
-
libtmux::Server:: control - Namespace
- libtmux
- Declared in
Server- Package
- libtmux-cxx
- Source
- include/libtmux/server.hpp
- [[
C++ nodiscard attributeAsks the compiler to warn when a result is discarded. An explicit cast to void acknowledges that the result is intentionally ignored.]] expected<Connection, ProtocolError > control(std::string session) const;_view -
Description#
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, notCommandFailure, because that is what theConnectionit returns speaks: an error type here that the value's own surface does not use would make the doorway disagree with the room.- Parameters
Guides#
Pages that discuss control.