Core Library0.xAPI Reference

Choose documentation 3

Core Library API reference and guides

Home Guides Topics Concepts Examples API Reference

0.x Released; 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.

Swift API

class libtmux-swift latest

ControlSession

A live control-mode connection.

Base types ActorSendableSendableMetatype

Source and package

Qualified name: ControlSession
Package: libtmux-swift
Source: Sources/LibTmux/ControlSession.swift

class ControlSession : actor ControlSession class [source] ¶: Description#

Commands go in and numbered replies come back, so output belongs to the command that produced it — the attribution a ; list cannot give. Anything the server volunteers meanwhile arrives on notifications.

Members5#

Common operations1#

watch(_:) method Registers a format subscription on this connection.

Other members4#

changes(named:) method Every subscription change on this connection, optionally narrowed to one subscription's name.
notifications: var notifications: ControlNotificationStream property Everything the server volunteered: %output, %window-add, and the rest.
send(_:) method Sends a command and waits for the block tmux brackets its reply with.
stopWatching(_:) method Removes the subscription registered under name.

Inherited members3 members#

Reached through Actor.assertIsolated(_:file:line:), Actor.assumeIsolated(_:file:line:), Actor.preconditionIsolated(_:file:line:).

assertIsolated(_:file:line:) method inherited Stops program execution if the current task is not executing on this actor's serial executor.
assumeIsolated(_:file:line:) method inherited Assume that the current task is executing on this actor's serial executor, or stop program execution otherwise.
preconditionIsolated(_:file:line:) method inherited Stops program execution if the current task is not executing on this actor's serial executor.

Reference preview