Auto Light Dark

Core LibraryAPI Reference

Choose documentation 1

latest

Current version

English

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

Kotlin API

class libtmux-kotlin latest

ControlClient

Package i.g.l.kotlin io.github.libtmux.kotlin

A tmux client that stays attached and answers one command at a time.

View as Markdown

Source and package

Module: io.github.libtmux.kotlin
Package: io.github.libtmux:libtmux-kotlin
Source: libtmux-kotlin/src/main/kotlin/io/github/libtmux/kotlin/ControlClient.kt

public class ControlClient : AutoCloseable class [source] ¶: Description#

Holds the Java handle privately, so a member here always wins over a same-named catalog-generated extension in ControlClientOperations.kt .

Discussed in Coroutines and flows , Getting started

Members11 members#

Common operations2 members#

events method State changes tmux volunteers, as a cold Flow . Reads, and takes onSubscribed , as output does.
output method Terminal output tmux pushes, as a cold Flow .

Other members9 members#

asJava property The Java control client this wraps: the same object, for a Java API that takes one.
close method Ends the client, rejecting queued requests and resolving picked requests as uncertain.
isAlive property Whether the client is still running.
send method Runs one command and waits for its reply.
server property
standardError property The error text captured from this control process, at most 4096 bytes.
standardErrorTruncated property Whether standardError stopped before the process finished writing it.
unwatch method Stops a watch.
watch method Asks tmux to report a format whenever its value changes.