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

method libtmux-dotnet latest

TmuxTestFactory.CreateSessionAsync

Namespace L.Testing LibTmux.Testing

Starts a server and a session in it, both owned by this test.

View as Markdown

Source and package

Module: LibTmux.Testing
Declared in: TmuxTestFactory
Package: LibTmux
Source: src/LibTmux.Testing/TmuxTestFactory.cs

CreateSessionAsync ( options : TmuxTestOptions? , cancellationToken : CancellationToken ) → Task<TemporarySessionScope> ( server : Server , options : TmuxTestOptions? , cancellationToken : CancellationToken ) → Task<TemporarySessionScope> methodasyncoverload2 overloads [source] ¶

Description#

The server this makes is left to the session's own scope, which is a session on a server nobody else will kill.

Parameters

options ( TmuxTestOptions? ) – How to reach tmux, or null for a socket of its own. (for CreateSessionAsync(options, cancellationToken))
cancellationToken ( CancellationToken ) – Cancels the tmux commands.
server ( Server ) – The server to start it on. (for CreateSessionAsync(server, options, cancellationToken))
options ( TmuxTestOptions? ) – What to name it, or null for a name of its own. (for CreateSessionAsync(server, options, cancellationToken))

Returns

The scope owning the session.