Auto Light Dark

Core LibraryAPI Reference

Choose documentation 3

latest

Current version

English

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

C# API

interface libtmux-dotnet latest

IControlModeSession

Namespace LibTmux

A live tmux control client.

View as Markdown

Source and package

Module: LibTmux
Package: LibTmux
Source: src/LibTmux/ControlMode/IControlModeSession.cs

interface LibTmux.IControlModeSession interface [source] ¶: Description#

One-shot commands start a tmux client, run one thing, and exit. A control session keeps one client for as long as it is held, which is what makes tmux willing to report what happens while nobody asked: pane output, windows appearing, sessions changing.
Disposing ends the client. Everything a caller reads comes through Events , which completes after a normal exit and faults after buffered events when the control stream fails.

Members3 members#

Other members3 members#

Events property Reads what tmux reports for as long as the client runs.
IsRunning property Gets whether the client is still running.
SendAsync method Runs one command on this client and reads what it answered.