method libtmux-dotnet latest
ServerMirror.OpenAsync
Mirrors the server an anchor session belongs to.
Source and package
- Module
- LibTmux
- Declared in
- ServerMirror
- Package
- LibTmux
- Source
- src/LibTmux/Snapshots/ServerMirror.cs
- OpenAsync ( anchor : Session , refreshEvery : Time
Span , cancellationToken : CancellationToken ) Task<ServerMirror > -
- Parameters
-
-
anchor ( Session ) – The session the mirror's control client attaches to.
-
refreshEvery ( Time
Span ) – How long a quiet mirror waits before capturing anyway, so a change tmux does not announce is seen within that long; zero never does. -
cancellationToken ( Cancellation
Token ) – Cancels attaching and the first capture.
-
- Returns
-
A mirror whose first view is already captured.
- Raises
-
-
Argument
Out – The refresh interval is negative.Of Range Exception -
Incomplete
Snapshot – The session was not read through a server.Exception
-