Core LibraryAPI Reference

Choose documentation 3

latest

Current version

latest
English

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

C# API

method libtmux-dotnet latest

Server.Within

Namespace LibTmux.Server.Within LibTmux

Returns this server with every command bounded by a timeout of the caller's choosing.

View as Markdown

Source and package
Module
LibTmux
Declared in
Server
Package
LibTmux
Source
src/LibTmux/Server.Identity.cs
Within ( timeout : TimeSpan ) → Server
method [source]

Description#

The handle shares this one's connection, so nothing is started or verified again, and it compares equal to this one. A command that outlasts the bound throws TmuxTransportException whose Dispatch is Unknown , as with CommandTimeout . A caller's own cancellation still reads as cancellation.

Parameters
  • timeout ( TimeSpan ) – How long tmux may take to answer each command.

Returns

A handle to the same server. Every session, window, pane and client taken from it gives tmux the same bound.

Raises
Esc

Type to search.