C# API

method libtmux-dotnet latest

Server.GetClientsAsync

Namespace LibTmux

Reads the clients attached to this server.

View as Markdown

Source and package

Module: LibTmux
Declared in: Server
Package: LibTmux
Source: src/LibTmux/Server.Clients.cs

GetClientsAsync ( cancellationToken : CancellationToken ) → Task<IReadOnlyList<Client>> methodasync [source] ¶

Description#

A handle that has not found a live server yet discovers one first.

Examples#

Read scalar listings from two detached sessions on a private server. Fresh rows do not imply captured child relations. Use Linux or macOS with Git, tmux 3.2a or newer, .NET SDK 10.0.303, and the .NET 8 and 10 runtimes. In an empty directory, fetch the documented library revision:

$ git clone https://github.com/libtmux/libtmux-dotnet.git libtmux-source && \
  git -C libtmux-source checkout --detach cf34b255c896d19a97e7d7fabea58609c916012d

Save this complete consumer setup as global.json: View source

{
  "sdk": {
    "version": "10.0.303",
    "rollForward": "disable",
    "allowPrerelease": false
  },
  "test": {
    "runner": "Microsoft.Testing.Platform"
  }
}

Save this complete consumer setup as NuGet.config: View source

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <packageSources>
    <clear />
    <add key="libtmux-source" value="libtmux-source/artifacts/api-example-packages" />
    <add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
  </packageSources>
  <packageSourceMapping>
    <clear />
    <packageSource key="libtmux-source">
      <package pattern="LibTmux" />
      <package pattern="LibTmux.*" />
    </packageSource>
    <packageSource key="nuget.org">
      <package pattern="*" />
    </packageSource>
  </packageSourceMapping>
</configuration>

Save this complete consumer setup as Example.csproj: View source

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFrameworks>net8.0;net10.0</TargetFrameworks>
    <LangVersion>12.0</LangVersion>
    <Nullable>enable</Nullable>
    <ImplicitUsings>disable</ImplicitUsings>
    <EnableDefaultCompileItems>false</EnableDefaultCompileItems>
    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
    <AnalysisLevel>10-recommended</AnalysisLevel>
  </PropertyGroup>
  <ItemGroup>
    <Compile Include="Program.cs" />
    <PackageReference Include="LibTmux" Version="[0.0.0-alpha.20]" />
  </ItemGroup>
</Project>

Save this complete program as Program.cs. It creates a private server; await using disposes its owned scopes after success, cancellation or failure. The complete file contains explicit imports, a top-level async entry point and a cancellation deadline. View source

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using LibTmux;

if (OperatingSystem.IsWindows())
{
    throw new PlatformNotSupportedException("This example requires tmux on Linux or macOS.");
}

using CancellationTokenSource deadline = new(TimeSpan.FromSeconds(10));
CancellationToken token = deadline.Token;
string binary = Environment.GetEnvironmentVariable("LIBTMUX_TMUX") ?? "tmux";
string socketName = "csharp-serverlistings-" + Guid.NewGuid().ToString("N");
ServerConnectionOptions options = new()
{
    SocketName = socketName,
    ConfigurationFile = "/dev/null",
    TmuxBinaryPath = binary,
};

await using OwnedServerScope owned = await Server.CreateOwnedAsync(options, token);
await using OwnedSessionScope demo = await owned.Value.CreateOwnedSessionAsync(
    new NewSessionRequest { Name = "demo", Command = "/bin/cat" }, token);
await using OwnedSessionScope worker = await owned.Value.CreateOwnedSessionAsync(
    new NewSessionRequest { Name = "worker", Command = "/bin/cat" }, token);
Server server = await Server.ConnectAsync(options, token);

IReadOnlyList<Session> sessions = await server.GetSessionsAsync(token);
IReadOnlyList<Window> windows = await server.GetWindowsAsync(token);
IReadOnlyList<Pane> panes = await server.GetPanesAsync(token);
IReadOnlyList<Client> clients = await server.GetClientsAsync(token);
if (sessions.Count != 2 || windows.Count != 2 || panes.Count != 2 || clients.Count != 0)
{
    throw new InvalidOperationException("Expected two detached sessions, each with one window and pane.");
}
if (sessions.Any(session => session.Windows.IsCaptured))
{
    throw new InvalidOperationException("Scalar listings must not imply captured child relations.");
}

foreach (Session session in sessions.OrderBy(session => session.Name, StringComparer.Ordinal))
{
    Console.WriteLine($"Session: {session.Name} ({session.Id})");
}
Console.WriteLine($"Windows: {windows.Count}; panes: {panes.Count}; clients: {clients.Count}");

Build the exact source package and the saved consumer, then run both supported frameworks. The local package feed prevents an unrelated published package from satisfying the restore. Each program checks its result and exits unsuccessfully after an unhandled error:

$ export NUGET_PACKAGES="$PWD/packages" && \
  dotnet restore libtmux-source/src/LibTmux/LibTmux.csproj --locked-mode && \
  dotnet pack libtmux-source/src/LibTmux/LibTmux.csproj \
    --configuration Release --no-restore -p:ContinuousIntegrationBuild=true \
    --output "$PWD/libtmux-source/artifacts/api-example-packages" && \
  dotnet restore Example.csproj --configfile NuGet.config && \
  dotnet build Example.csproj --configuration Release --no-restore --warnaserror && \
  export LIBTMUX_TMUX="$(command -v tmux)" && \
  export TMUX_TMPDIR=/tmp/libtmux-dotnet-dev && \
  mkdir -p "$TMUX_TMPDIR" && \
  unset TMUX TMUX_PANE && \
  dotnet bin/Release/net8.0/Example.dll && \
  dotnet bin/Release/net10.0/Example.dll

Expected program output from each framework:

Session: demo ($0)
Session: worker ($1)
Windows: 2; panes: 2; clients: 0

Parameters

cancellationToken ( CancellationToken ) – Cancels the tmux command.

Returns

The clients tmux reports.

Raises

LibTmuxException – The listing failed, including an absent daemon.

Scripting & web

Compiled & native

JVM

.NET

tmux

Server.GetClientsAsync

Description#

Examples#

Description#

Examples#

Related types#