Client
A client attached to a tmux server.
Source and package
- Qualified name
-
Client - Package
- libtmux-swift
- Source
- Sources/LibTmux/Client.swift
-
Description#
tmux targets a client by its current name or tty, not by
client_pid. A disconnect followed by name reuse can therefore make a held value name a replacement within the same daemon. The process id remains useful metadata, but it is not a stable client-target key.
Members17#
- activePaneID: let active
Pane : PaneID ID ? property The globally active pane in the client's current session window. - filterFieldID(for:) method The stable wire id for a key path, or
nilif the property is not filterable. - filterFieldType(_:) method The value kind an id names, or
nilwhen this model does not know it. - filterFormatField(_:) method No field lowers unless a model says so, so a conformance written before this existed keeps working and simply filters at home.
- filterValue(_:of:) method Reads the field an id names, or
nilif this model has no such field. - height: let height: Int? property The terminal's height in cells, absent on the same terms as
width. - id: var id: String property The client's name, which is its terminal path for an ordinary client.
- incarnation: let incarnation: Server
Incarnation property The daemon this value was read from. - init(from:) method Decodes a client, treating an absent
flagsas an empty set so that a payload written before the field existed still reads back. - init(name:tty:processID:width:height:isControlMode:sessionID:activePaneID:isWindowZoomed:incarnation:) method
- isControlMode: let is
Control : Bool property Whether this client is a control-mode connection rather than a terminal.Mode - isWindowZoomed: let is
Window : Bool? property Whether the client's active window is zoomed.Zoomed - name: let name: String property tmux's name for the client, which for a terminal is the path of its tty. It is what a command targeting a client has to say.
- processID: let process
ID : Int property The client process, which is not the server: killing it detaches rather than shutting anything down. - sessionID: let session
ID : SessionID property The session the client is looking at. A client attaches to exactly one, and switching sessions changes this rather than making a new client. - tty: let tty: String property The terminal device behind the client, empty for one with no terminal.
- width: let width: Int? property The terminal's width in cells, absent for a client that has no terminal. tmux reports it as empty for a control-mode connection, so
nilis what it said rather than a zero this library invented.
Inherited members1 member#
Reached through Equatable.!=(_:_:).
Guides#
Pages that discuss Client.