Core LibraryunreleasedAPI Reference

Choose documentation 2

latest

Current version

latest
English

Unreleased LibTmux has not been released. Its API may change during development. This site's structure and URLs may change too.

class libtmux-perl latest

Session

Captured session entity

Base types LibTmux::Entity
Source and package
Qualified name
LibTmux::Session
Module
LibTmux
Package
LibTmux
Source
packages/core/lib/LibTmux/Session.pm
Other languages
ErlangPowerShellcmdlet Juliastruct Elixirstruct Haskell Common Lispclass PythonRubyLuaTypeScriptRustGoJavaC#C++SwiftKotlinScalaOCamlF#module Clojurefunction

Description#

OWNERSHIP

Readers use the retained graph and never refresh it. Acquire a new snapshot for new state. Inherited to_record exports a detached scalar record.

Members6#

Common operations5#

  • id method string. Local captured data; no I/O.
  • name method string. Local captured data; no I/O.
  • attached method integer. Local captured data; no I/O.
  • created method integer. Local captured data; no I/O.
  • path method bytes. Local captured data; no I/O.

Other members1#

Inherited members5 members#

Reached through LibTmux::Entity.

  • generation method inherited Return the captured generation. Restarted daemons cannot silently reuse this handle.
  • identity method inherited Return an opaque identity key scoped by server, generation, kind, and string ID. It is suitable for local equality; duplicate selection occurrences remain separate occurrences.
  • kind method inherited Return the schema entity-kind string. Concrete public field readers belong to LibTmux::Pane, LibTmux::Window, LibTmux::WindowLink, LibTmux::Session, and LibTmux::Client.
  • server_id method inherited Return the captured server scope. No daemon discovery or refresh occurs.
  • to_record method inherited Return a fresh hash reference of captured scalar fields and adjacency IDs. Editing it does not change the retained graph. Retaining the entity retains its captured graph, with no transport ownership or reference cycle.

In other ports#

A tmux session

Equivalents of A tmux session in other languages
Language Equivalent
Python libtmux.Session
Ruby LibTmux::Session
Lua libtmux.Session
PowerShell LibTmux\Get-TmuxSession This cmdlet reads and returns shared .NET LibTmux.Session objects. Child windows and panes require further acquisition.
Julia LibTmux.SessionSnapshot SessionSnapshot holds captured session data. Actions use its SessionRef, a typed identity bound to an observed daemon generation.
Erlang #tmux_model:session{}
Elixir LibTmux.Session Session is an immutable observation. Fields not captured read as :unloaded.
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
Common Lisp libtmux:session session is an immutable captured entity. The same name also has a relation accessor with a distinct public identity.
TypeScript session.Session
Rust session.Session
Go tmux.Session
Java io.github.libtmux.Session
Clojure libtmux.core/sessions! Acquires a vector of captured session maps. The session value is a map, not a wrapper class.
Kotlin io.github.libtmux.kotlin.Session
Scala io.github.libtmux.scaladsl.Session
C# LibTmux.Session
F# LibTmux.FSharp.Session This F# module builds deferred child queries from a shared .NET LibTmux.Session and its server association. Query.list acquires their results from tmux.
C++ libtmux::Session
Swift Session
OCaml Libtmux.Session.t
Esc

Type to search.

Reference previewOpen reference