C++ API

method libtmux-cxx latest

Client.session

Source and package

Qualified name: libtmux::Client::session
Namespace: libtmux
Declared in: Client
Package: libtmux-cxx
Source: include/libtmux/entities.hpp
Other languages: Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp Python RubyLuaTypeScriptRustGoJavaC# Swift KotlinScalaOCamlfunction F# 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<Session, CommandFailure> session() const; method readonly [source] ¶

tmux command#

The tmux commands behind session.

The C declarations in tmux that implement these commands.

The session a client is attached to

Equivalents of The session a client is attached to in other languages
Language	Equivalent
Python	client_session is a session name, not a Session object
Ruby	`LibTmux::ClientSnapshot#session`
Lua	`libtmux.SnapshotClient.session`
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript	`client.Client.session`
Rust	`client.Client.attached_session`
Go	`tmux.Client.AttachedSession`
Java	`io.github.libtmux.Client.session`
Kotlin	`io.github.libtmux.kotlin.Client.session`
Scala	`io.github.libtmux.scaladsl.Client.session`
C#	`LibTmux.Client.GetAttachedSessionAsync`
Swift	the relationship is resolved through Snapshot.session(of:)
OCaml	`Libtmux.Client_observation.session` Returns the captured session when the attached client had one.
Perl	`LibTmux::Client::session` Captured nullable relation; unloaded data remains an error.

No equivalent is recorded in PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure or F#.