Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

CallerIdentity

Swift
  • Python Unavailable
  • Ruby Unavailable
  • Lua Unavailable
  • TypeScript Unavailable
  • Rust Unavailable
  • Go Unavailable
  • Java Unavailable
  • .NET Unavailable
  • C++ Unavailable
  • Swift

API reference · Markdown

struct CallerIdentity : struct CallerIdentity
struct [source]
struct [source]
struct CallerIdentity

Where this MCP server is itself running, when that is inside tmux.

An agent driving tmux from a pane is one kill-pane away from ending the conversation it is having. Knowing which pane is its own is what lets the tools refuse that, and lets a listing mark the row that is the caller so the agent never has to ask.

Members

!=(_:_:)

!=(_:_:) ( lhs : Self , rhs : Self ) → Bool
functionstatic
functionstatic
!=(_:_:)

Inherited from Equatable.!=(_:_:)

Returns a Boolean value indicating whether two values are not equal.

Inequality is the inverse of equality. For any values a and b, a != b implies that a == b is false.

This is the default implementation of the not-equal-to operator (!=) for any type that conforms to Equatable.

  • Parameters:
    • lhs: A value to compare.
    • rhs: Another value to compare.

paneID

paneID : let paneID: PaneID?
property [source]
property [source]
paneID

From TMUX_PANE, which tmux sets in every process it starts.

sessionID

sessionID : let sessionID: SessionID?
property [source]
property [source]
sessionID

From TMUX, in the same $… spelling as a session id.

socketPath

socketPath : let socketPath: String?
property [source]
property [source]
socketPath

serverProcessID

serverProcessID : let serverProcessID: Int?
property [source]
property [source]
serverProcessID

The surrounding server's process id. It authenticates alternate routes to one socket and rejects a daemon that replaced one exact route.

current(environment:)

current(environment:) ( environment : [String : String] ) → CallerIdentity?
methodstatic [source]
methodstatic [source]
current(environment:)

Reads the surrounding tmux, or nil when both context variables are absent.

An incomplete or malformed environment remains present as an invalid identity so an input guard cannot mistake it for a detached process.

isOn(_:)

isOn(_:) ( server : ServerIncarnation ) → Bool
method [source]
method [source]
isOn(_:)

Whether server is the tmux this process is running inside, including when caller and server reached its socket through different links.

init(from:)

init(from:) ( from : any Decoder )
method
method
init(from:)

Inherited from Decodable.init(from:)

Creates a new instance by decoding from the given decoder.

This initializer throws an error if reading from the decoder fails, or if the data read is corrupted or otherwise invalid.

  • Parameter decoder: The decoder to read data from.
Esc

Type to search.