Server.CreateSessionWithReceiptAsync
Creates a session and returns its initial window and pane identities.
Source and package
- Module
- LibTmux
- Declared in
- Server
- Package
- LibTmux
- Source
- src/LibTmux/Server.Lifecycle.cs
- CreateSessionWithReceiptAsync ( request : New
Session ? , cancellationToken : CancellationRequest Token ) Task<SessionCreation >Result -
Description#
The returned session is bound to the creating daemon. Its child identifiers are creation-time facts, not a snapshot or a promise that the children still belong to the session. A failed readback publishes no receipt or cleanup ownership.
- Parameters
-
-
request ( New
Session ? ) – The session to create.Request -
cancellationToken ( Cancellation
Token ) – Cancels creation and readback.
-
- Returns
-
The created session and child identifiers from the same creation reply.
- Raises
-
-
Argument
Exception – The name is invalid, or generation-bound creation requests replacement. -
Tmux
Session – The name is already taken.Exists Exception -
Lib
Tmux – Creation or readback failed; a failure after creation has unknown dispatch outcome.Exception
-