C# API

struct libtmux-dotnet latest

ServerConnectionOptions

Namespace LibTmux

Configures a tmux server connection without mutating process-wide state.

Source and package

struct LibTmux.ServerConnectionOptions struct [source] ¶: Description#

Every option is set through an initializer. A constructor parameter binds at the call site when it compiles, so adding one would break an assembly already built against the old signature - and this is the type most likely to grow one.

Discussed in Use the C# workspace builder · Socket and servers

Members15 members#

ChildEnvironment property Gets the child-process environment overrides.
ColorMode property Gets the requested tmux color mode.
CommandTimeout property Gets how long one tmux command may run, or null to wait indefinitely.
ConfigurationFile property Gets the tmux configuration file.
ControlModeEventBufferCapacity property Gets how many control-mode events are buffered before pane output is dropped.
ControlModeEventBufferMaxBytes property Gets the UTF-8 payload byte ceiling for buffered control-mode notifications.
Default property Gets conventional connection defaults.
InitializeAsync property Gets the post-connect initializer.
Interceptor property Gets what every tmux invocation on this connection passes through, or null.
Logger property Gets the connection logger.
MaxCapturedBytesPerStream property Gets the largest output one command may capture, in bytes.
SocketName property Gets the explicit socket name.
SocketNameFactory property Gets the deferred socket-name factory.
SocketPath property Gets the explicit socket path.
TmuxBinaryPath property Gets the tmux executable path.