Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

wait_for_channel

Wait for a named server-side channel with an optional deadline. Change tmux state; no client-supplied executable input.

All C++ tools · JSON · Source

Arguments

channel required · string
Bounded channel name.
timeoutMs optional · integer
Optional bounded wait in milliseconds.

Schemas

The schema defines required fields, nested values, defaults, and validation constraints.

Input schema
{
"additionalProperties": false,
"properties": {
"channel": {
"description": "Bounded channel name.",
"maxLength": 256,
"type": "string"
},
"timeoutMs": {
"description": "Optional bounded wait in milliseconds.",
"maximum": 60000,
"minimum": 1,
"type": "integer"
}
},
"required": [
"channel"
],
"type": "object"
}
Output schema
{
"additionalProperties": true,
"type": "object"
}
Tool annotations
{
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true,
"readOnlyHint": false,
"title": "Wait for a tmux channel"
}
Esc

Type to search.