Session

struct Session : struct Session

struct [source] ¶

struct [source] ¶

struct Session

Bases:

• Copyable
• Decodable
• Encodable
• Equatable
• Filterable
• Hashable
• Identifiable
• Sendable
• SendableMetatype

A tmux session, as it was when the listing was read.

This is a value, not a live handle: nothing here re-reads tmux, and two copies never disagree. Ask the server again for a newer view.

Discussed in Swift workspace builder behavior , Swift workspace builder API · Architecture , Traversal

In other ports A tmux session

• Python libtmux.Session
• Ruby LibTmux::Session
• Lua libtmux.Session
• TypeScript session.Session
• Rust session.Session
• Go tmux.Session
• Java io.github.libtmux.Session.Session
• .NET LibTmux.Session
• C++ libtmux::Session

Members

• id property tmux's own session id, stable for the session's lifetime — $0, $1. Names are not: a session can be renamed, and two servers can both have a 0.
• name property What a person calls it, and what tmux matches when a command names a session. Renameable, so it is not an identity.
• isAttached property Whether any client is looking at this session. Opening a connection attaches one, so this reads differently from inside Server/connected(attachingTo:_:) — see <doc:Modes>.
• createdAt property When tmux created the session, in seconds since the epoch. tmux's clock, not this process's.
• windowCount property tmux's own count, so a caller needing only the number does not have to list the windows to get it.
• filterFieldID(for:) method The stable wire id for a key path, or nil if the property is not filterable.
• filterFieldType(_:) method The value kind an id names, or nil when this model does not know it.
• filterFormatField(_:) method The tmux format field an id reads, or nil when it has no single one.
• filterValue(_:of:) method Reads the field an id names, or nil if this model has no such field.
• incarnation property The daemon this value was read from.
• init(id:name:windowCount:isAttached:createdAt:incarnation:) method