Session.AttachAsync
Attaches a client to this session.
Source and package
- Module
- LibTmux
- Declared in
- Session
- Package
- LibTmux
- Source
- src/LibTmux/Session.Lifecycle.cs
- AttachAsync ( request : Attach
Session ? , cancellationToken : CancellationRequest Token ) Task<Session> -
Description#
Attaching inherits the caller's terminal on stdin and waits for detach. A positive acknowledgement is required within five seconds, or a shorter
CommandTimeout. CommandTimeout still bounds the whole attachment; null permits an indefinite interactive lifetime after acknowledgement. Cancellation stops only the owned client.Targetremains a raw target override; leave it unset to attach this session by its identifier.- Parameters
-
-
request ( Attach
Session ? ) – Attachment options.Request -
cancellationToken ( Cancellation
Token ) – Cancels the tmux command.
-
- Returns
-
A refreshed handle for this session.