C++

Choose a port 22

Scripting & web

PythonNo matching page

RubyNo matching page

LuaNo matching page

JuliaNo matching page

TypeScriptNo matching page

PerlNo matching page

Compiled & native

RustNo matching page

GoNo matching page

Common LispNo matching page

SwiftNo matching page

OCamlNo matching page

HaskellNo matching page

JVM

JavaNo matching page

KotlinNo matching page

ScalaNo matching page

ClojureNo matching page

.NET

C#No matching page

F#No matching page

PowerShellNo matching page

BEAM

ErlangNo matching page

ElixirNo matching page

tmux

Packages

Packages and source 6

libtmuxvcpkg port · libtmux/libtmux-cxx vcpkg portregistry · ports/libtmux libtmux::libtmuxtarget · src libtmux::testingcomponent · src/testing libtmux-mcp-serverexecutable · apps/mcp tmux-workspaceexecutable · apps/workspace

C++ · libtmux/libtmux-cxx

Auto Light Dark

Core LibraryalphaAPI Reference

Choose documentation 3

Core Library API reference and guides

Home Guides Topics Concepts Examples API Reference

alpha Alpha release; the API may change. Read more

MCP Tools for connected assistants

Home Guides Topics Examples Tools Prompts Resources API Reference

concept Working example; may change without notice. Read more

Workspace Manager Repeatable development environments

Home Guides Examples CLI Manual API Reference Configuration Internals

concept Working example; may change without notice. Read more

latest

Current version

English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

C++ API

method libtmux-cxx latest

CommandRuntime.ready_fd

Readable exactly when wait_ready() would return without blocking, for a caller that owns an event loop and cannot park a thread in wait_ready().

Source and package

Qualified name: libtmux::CommandRuntime::ready_fd
Namespace: libtmux
Declared in: CommandRuntime
Package: libtmux-cxx
Source: include/libtmux/async.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.Language documentation]] int ready_fd() const noexcept; method readonly [source] ¶: Description#

The same contract as Connection::notification_fd():
Readability is the signal. Do not read from it: the byte carries nothing and is this runtime's to consume. Drain by taking the work — dispatch_ready() or discard_ready() — which clears it.
A closed runtime makes it readable, so a poller learns that no answer is coming rather than waiting for one.
Valid until this runtime is destroyed or moved from. -1 when the pipe could not be created, and on Windows, where the runtime has no descriptor to offer; a caller that gets -1 uses wait_ready().

Reference preview