C++ API

method libtmux-cxx latest

Server.clients

Source and package

Qualified name: libtmux::Server::clients
Namespace: libtmux
Declared in: Server
Package: libtmux-cxx
Source: include/libtmux/server.hpp
Other languages: Perlmethod Erlang PowerShellcmdlet Juliafunction Elixirfunction Haskell Common Lispfunction PythonRuby Lua TypeScriptRustGoJavaC#SwiftKotlinScalaOCamlfunction F#function Clojure

[[C++ nodiscard attributeAsks the compiler to warn when a result is discarded. An explicit cast to void acknowledges that the result is intentionally ignored.Language documentation]] expected<std::vector<Client>, CommandFailure> clients() const; method readonly [source] ¶

Examples#

List server objects. Read independent snapshots of every session, window, pane, and client. Iterating these vectors makes no further tmux calls. The detached fixture has one session, one window, one pane, and no attached clients. libtmux-cxx is not published to a package registry yet, so this builds it from its repository. Use Clang 18 or newer with libc++, CMake 3.25 or newer, Ninja, Git, and tmux 3.3a or newer on Linux. In an empty directory, fetch the documented library revision:

$ git clone https://github.com/libtmux/libtmux-cxx.git libtmux-source && \
  git -C libtmux-source checkout 542fdc204ff3cfa56f5484327cda0c69bad2307d

Build and install the C++23 library and its public testing component into this directory:

$ cmake -S libtmux-source -B libtmux-build -G Ninja \
    -DCMAKE_TOOLCHAIN_FILE="$PWD/libtmux-source/cmake/toolchains/clang-libcxx.cmake" \
    -DCMAKE_C_COMPILER=clang \
    -DCMAKE_CXX_COMPILER=clang++ \
    -DCMAKE_BUILD_TYPE=Release \
    -DLIBTMUX_BUILD_TESTS=OFF \
    -DLIBTMUX_BUILD_EXAMPLES=OFF \
    -DLIBTMUX_BUILD_TESTING_LIBRARY=ON && \
  cmake --build libtmux-build --parallel 2 && \
  cmake --install libtmux-build --prefix "$PWD/libtmux-prefix"

Save this complete consumer project as CMakeLists.txt: View source

cmake_minimum_required(VERSION 3.25)
project(libtmux_api_example LANGUAGES CXX)

find_package(libtmux REQUIRED COMPONENTS testing)

add_executable(api_example main.cpp)
target_link_libraries(api_example PRIVATE libtmux::libtmux libtmux::testing)

Save this complete program as main.cpp. ScopedTmuxServer owns a private daemon and stops it when the program exits. Ordinary applications use Server for their own socket; these examples use the fixture until setup moves to ordinary server objects. View source

#include <cstdio>

#include <libtmux/libtmux.hpp>
#include <libtmux/testing/scoped_server.hpp>

int main() {
  // The fixture owns this private server and cleans it up on every return path.
  auto fixture = libtmux::test::ScopedTmuxServer::start({
      .session_name = "api",
      .socket_namespace = libtmux::test::SocketNamespace::consumer("api"),
  });
  if (!fixture.has_value()) {
    std::fprintf(stderr, "%s\n", fixture.error().c_str());
    return 1;
  }
  auto server = libtmux::Server::at_socket_path(fixture->socket_path());
  if (!server.has_value()) {
    std::fprintf(stderr, "%s\n", server.error().diagnostic.c_str());
    return 1;
  }

  const auto sessions = server->sessions();
  const auto windows = server->windows();
  const auto panes = server->panes();
  const auto clients = server->clients();
  if (!sessions.has_value()) {
    std::fprintf(stderr, "%s\n", sessions.error().diagnostic.c_str());
    return 1;
  }
  if (!windows.has_value()) {
    std::fprintf(stderr, "%s\n", windows.error().diagnostic.c_str());
    return 1;
  }
  if (!panes.has_value()) {
    std::fprintf(stderr, "%s\n", panes.error().diagnostic.c_str());
    return 1;
  }
  if (!clients.has_value()) {
    std::fprintf(stderr, "%s\n", clients.error().diagnostic.c_str());
    return 1;
  }
  if (sessions->size() != 1 || windows->size() != 1 || panes->size() != 1 ||
      !clients->empty()) {
    std::fputs("unexpected detached server contents\n", stderr);
    return 1;
  }
  std::printf("sessions=%zu windows=%zu panes=%zu clients=%zu\n", sessions->size(),
              windows->size(), panes->size(), clients->size());
  return 0;
}

Build against the installed library and run the saved program. An operation error produces a failing exit status:

$ cmake -S . -B build -G Ninja \
    -DCMAKE_PREFIX_PATH="$PWD/libtmux-prefix" \
    -DCMAKE_CXX_COMPILER=clang++ \
    -DCMAKE_CXX_FLAGS=-stdlib=libc++ && \
  cmake --build build --parallel 2 && \
  ./build/api_example

Expected output:

sessions=1 windows=1 panes=1 clients=0

tmux command#

The tmux commands behind clients.

list-clients

tmux C API#

The C declarations in tmux that implement these commands.

cmd_list_clients_entry cmd_list_clients_exec

In other ports#

List the server's attached clients

Equivalents of List the server's attached clients in other languages
Language	Equivalent
Python	`libtmux.Server.clients`
Ruby	`LibTmux::Server#list_clients`
PowerShell	`LibTmux\Get-TmuxClient` Acquires attached clients through `-Server` and returns shared .NET `LibTmux.Client` objects.
Julia	`LibTmux.clients` `clients` reads attached clients from a captured `Snapshot` without contacting tmux.
Elixir	`LibTmux.Snapshot.clients/1` Returns a `Selection` of captured attached clients without contacting tmux.
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
Common Lisp	`libtmux:clients` `clients` returns fresh attached-client observations from a retained snapshot.
TypeScript	`server.Server.clients`
Rust	`server.Server.clients`
Go	`tmux.Server.Clients`
Java	`io.github.libtmux.Server.clients`
Clojure	`libtmux.core/clients!`
Kotlin	`io.github.libtmux.kotlin.Server.clients`
Scala	`io.github.libtmux.scaladsl.Server.clients`
C#	`LibTmux.Server.Clients`
F#	`LibTmux.FSharp.Server.clients` Builds a deferred client query on the shared .NET `LibTmux.Server`. `Query.list` acquires attached clients.
Swift	`Server.clients()`
OCaml	`Libtmux.Snapshot.clients` Reads captured attached-client observations, separate from transport Client.t handles.
Perl	`LibTmux::Snapshot::clients` Local captured client membership; Server::clients explicitly acquires a new graph.

No equivalent is recorded in Lua or Erlang.

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

Server.clients

Examples#

tmux command#

tmux C API#

In other ports#

Examples#

tmux command#

tmux C API#

In other ports#

Related types#