Core Library0.xAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

method libtmux-ruby latest

Server.list_clients

Behavior: Live acquisition.

Source and package
Qualified name
LibTmux::Server#list_clients
Module
LibTmux
Declared in
Server
Package
libtmux
Source
gems/libtmux/lib/libtmux/operations.rb
Other languages
Perlmethod Erlang PowerShellcmdlet Juliafunction Elixirfunction Haskell Common Lispfunction Python Lua TypeScriptRustGoJavaC#C++SwiftKotlinScalaOCamlfunction F#function Clojure
def list_clients: ( ?timeout: ::Numeric, ?cancel: untyped ) -> ::Array[ { name: ::String, pid: ::Integer, created: ::Integer, tty: ::String?, session_id: ::String?, control: bool } ]

Description#

Behavior contract: Live acquisition.

Parameters

tmux command#

The tmux commands behind list_clients.

tmux C API#

The C declarations in tmux that implement these commands.

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
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.
C++ libtmux::Server::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.

Esc

Type to search.

Reference previewOpen reference