Auto Light Dark

Core LibraryAPI Reference

Choose documentation 1

latest

Current version

English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

F# API

function libtmux-fsharp latest

Mirror.start

Namespace L.FSharp LibTmux.FSharp

Mirrors the server an anchor session belongs to, capturing on each announcement.

View as Markdown

Source and package

Module: LibTmux.FSharp
Declared in: Mirror
Package: LibTmux.FSharp
Source: src/LibTmux.FSharp/Control.fsi

F# value signatures Declares the name and type of a value or function in a signature. Language documentation start: cancellationToken: CancellationToken -> anchor: LibTmux.Session -> Task<ServerMirror>

function [source] ¶

Description#

The caller owns and asynchronously disposes the returned mirror.

Parameters

cancellationToken ( CancellationToken )
anchor ( LibTmux.Session )

Raises

LibTmux.IncompleteSnapshotException – The session was not read through a server.

Discussed in Quick start , Streams and cleanup