# Ruby API reference Source: https://libtmux.org/en/ruby/latest/reference/ > Types, methods, and functions in libtmux for Ruby. Ruby API 765 symbols, extracted from source. Every type name in a signature links to its own entry; every cross-reference in a doc comment resolves against the same table. Server 1 type [Server 38 members](https://libtmux.org/en/ruby/latest/reference/libtmux-server/) Connects to an existing endpoint. Closing retires clients, never the daemon. Session 1 type, 1 function or constant [Session 21 members](https://libtmux.org/en/ruby/latest/reference/libtmux-session-nvps/) * SessionWhere modulelibtmux \[[source](https://github.com/libtmux/libtmux-ruby/blob/c6d9d21771828e583692ca899ed817f9640d6a55/gems/libtmux/lib/libtmux/criteria.rb#L405)] [¶](#LibTmux::SessionWhere "Permalink to SessionWhere") modulelibtmux \[[source](https://github.com/libtmux/libtmux-ruby/blob/c6d9d21771828e583692ca899ed817f9640d6a55/gems/libtmux/lib/libtmux/criteria.rb#L405)] [¶](#LibTmux::SessionWhere "Permalink to SessionWhere") SessionWhere Window 2 types, 2 functions and constants [Window 18 members](https://libtmux.org/en/ruby/latest/reference/libtmux-window-1vfx/) [WindowLink 19 members](https://libtmux.org/en/ruby/latest/reference/libtmux-windowlink-tusj/) * WindowLinkWhere modulelibtmux \[[source](https://github.com/libtmux/libtmux-ruby/blob/c6d9d21771828e583692ca899ed817f9640d6a55/gems/libtmux/lib/libtmux/criteria.rb#L405)] [¶](#LibTmux::WindowLinkWhere "Permalink to WindowLinkWhere") modulelibtmux \[[source](https://github.com/libtmux/libtmux-ruby/blob/c6d9d21771828e583692ca899ed817f9640d6a55/gems/libtmux/lib/libtmux/criteria.rb#L405)] [¶](#LibTmux::WindowLinkWhere "Permalink to WindowLinkWhere") WindowLinkWhere - WindowWhere modulelibtmux \[[source](https://github.com/libtmux/libtmux-ruby/blob/c6d9d21771828e583692ca899ed817f9640d6a55/gems/libtmux/lib/libtmux/criteria.rb#L405)] [¶](#LibTmux::WindowWhere "Permalink to WindowWhere") modulelibtmux \[[source](https://github.com/libtmux/libtmux-ruby/blob/c6d9d21771828e583692ca899ed817f9640d6a55/gems/libtmux/lib/libtmux/criteria.rb#L405)] [¶](#LibTmux::WindowWhere "Permalink to WindowWhere") WindowWhere Pane 1 type, 1 function or constant [Pane 27 members](https://libtmux.org/en/ruby/latest/reference/libtmux-pane-14z6/) * PaneWhere modulelibtmux \[[source](https://github.com/libtmux/libtmux-ruby/blob/c6d9d21771828e583692ca899ed817f9640d6a55/gems/libtmux/lib/libtmux/criteria.rb#L405)] [¶](#LibTmux::PaneWhere "Permalink to PaneWhere") modulelibtmux \[[source](https://github.com/libtmux/libtmux-ruby/blob/c6d9d21771828e583692ca899ed817f9640d6a55/gems/libtmux/lib/libtmux/criteria.rb#L405)] [¶](#LibTmux::PaneWhere "Permalink to PaneWhere") PaneWhere Client 1 function or constant * ClientWhere modulelibtmux \[[source](https://github.com/libtmux/libtmux-ruby/blob/c6d9d21771828e583692ca899ed817f9640d6a55/gems/libtmux/lib/libtmux/criteria.rb#L405)] [¶](#LibTmux::ClientWhere "Permalink to ClientWhere") modulelibtmux \[[source](https://github.com/libtmux/libtmux-ruby/blob/c6d9d21771828e583692ca899ed817f9640d6a55/gems/libtmux/lib/libtmux/criteria.rb#L405)] [¶](#LibTmux::ClientWhere "Permalink to ClientWhere") ClientWhere Hooks 1 type [Hooks 5 members](https://libtmux.org/en/ruby/latest/reference/libtmux-hooks/) Hook values are executable tmux command strings, never literal data. Options 1 type [OptionValue 7 members](https://libtmux.org/en/ruby/latest/reference/libtmux-optionvalue/) Raw bytes remain available even when a caller requests a typed conversion. Commands 3 types [Cancellation 5 members](https://libtmux.org/en/ruby/latest/reference/libtmux-cancellation/) [CreationReceipt 5 members](https://libtmux.org/en/ruby/latest/reference/libtmux-creationreceipt/) IDs printed by the creation command itself, before later topology changes. A receipt proves creation, not continued ownership or current membership. [Endpoint 8 members](https://libtmux.org/en/ruby/latest/reference/libtmux-endpoint-s6cs/) Explicit executable and socket selection. Construction starts no clients. Control mode 4 types [ControlConnection 15 members](https://libtmux.org/en/ruby/latest/reference/libtmux-controlconnection/) [ControlSubscription 8 members](https://libtmux.org/en/ruby/latest/reference/libtmux-controlsubscription/) [GuardedBlock 8 members](https://libtmux.org/en/ruby/latest/reference/libtmux-guardedblock/) [GuardedReply 7 members](https://libtmux.org/en/ruby/latest/reference/libtmux-guardedreply/) Blocks observed between private boundaries may include hooks. They do not establish command ownership, final status, or completion of delayed effects. Queries — Expressions 1 type [FilterExpr 13 members](https://libtmux.org/en/ruby/latest/reference/libtmux-filterexpr-1wz0/) A schema-validated predicate over captured records; evaluation performs no I/O. Snapshots 8 types [CapturedRecord 7 members](https://libtmux.org/en/ruby/latest/reference/libtmux-capturedrecord-18ay/) [ClientSnapshot 21 members](https://libtmux.org/en/ruby/latest/reference/libtmux-clientsnapshot-w08e/) [PaneSnapshot 22 members](https://libtmux.org/en/ruby/latest/reference/libtmux-panesnapshot-43mz/) [Selection 14 members](https://libtmux.org/en/ruby/latest/reference/libtmux-selection/) Replayable captured membership. Snapshot construction owns record values. [SessionSnapshot 16 members](https://libtmux.org/en/ruby/latest/reference/libtmux-sessionsnapshot-xllu/) [Snapshot 14 members](https://libtmux.org/en/ruby/latest/reference/libtmux-snapshot/) A validated graph observed over an interval, with no transport reference. [WindowLinkSnapshot 14 members](https://libtmux.org/en/ruby/latest/reference/libtmux-windowlinksnapshot-vzc2/) [WindowSnapshot 16 members](https://libtmux.org/en/ruby/latest/reference/libtmux-windowsnapshot-19c3/) Errors 18 types [Cancelled 8 members](https://libtmux.org/en/ruby/latest/reference/libtmux-cancelled/) [CapacityError 8 members](https://libtmux.org/en/ruby/latest/reference/libtmux-capacityerror/) [ClosedError 8 members](https://libtmux.org/en/ruby/latest/reference/libtmux-closederror/) [CommandError 9 members](https://libtmux.org/en/ruby/latest/reference/libtmux-commanderror/) [DeadlineExceeded 8 members](https://libtmux.org/en/ruby/latest/reference/libtmux-deadlineexceeded/) [Error 8 members](https://libtmux.org/en/ruby/latest/reference/libtmux-error/) [FieldDecodeError 8 members](https://libtmux.org/en/ruby/latest/reference/libtmux-fielddecodeerror/) [IncompleteSnapshotError 8 members](https://libtmux.org/en/ruby/latest/reference/libtmux-incompletesnapshoterror/) [InconsistentSnapshotError 8 members](https://libtmux.org/en/ruby/latest/reference/libtmux-inconsistentsnapshoterror/) [InvalidFilterError 8 members](https://libtmux.org/en/ruby/latest/reference/libtmux-invalidfiltererror/) [MultipleMatchesError 8 members](https://libtmux.org/en/ruby/latest/reference/libtmux-multiplematcheserror/) [NoMatchError 8 members](https://libtmux.org/en/ruby/latest/reference/libtmux-nomatcherror/) [OutcomeUnknown 8 members](https://libtmux.org/en/ruby/latest/reference/libtmux-outcomeunknown/) [ProtocolError 8 members](https://libtmux.org/en/ruby/latest/reference/libtmux-protocolerror/) [SubscriptionOverflow 9 members](https://libtmux.org/en/ruby/latest/reference/libtmux-subscriptionoverflow/) [TargetNotFoundError 8 members](https://libtmux.org/en/ruby/latest/reference/libtmux-targetnotfounderror/) [TransportError 8 members](https://libtmux.org/en/ruby/latest/reference/libtmux-transporterror/) [UnsupportedFeatureError 8 members](https://libtmux.org/en/ruby/latest/reference/libtmux-unsupportedfeatureerror/) Constants and enums 5 types [CommandResult 11 members](https://libtmux.org/en/ruby/latest/reference/libtmux-commandresult/) [ControlEvent 13 members](https://libtmux.org/en/ruby/latest/reference/libtmux-controlevent/) [GroupResult 5 members](https://libtmux.org/en/ruby/latest/reference/libtmux-groupresult/) Final client status cannot attribute a merged group result to individual steps. [Options 4 members](https://libtmux.org/en/ruby/latest/reference/libtmux-options/) Explicit acquisition and mutation at one option scope. [TerminalResult 6 members](https://libtmux.org/en/ruby/latest/reference/libtmux-terminalresult/) Terminal bytes go directly to the caller's TTY and are not captured. Async 1 function or constant * Async modulelibtmux-async \[[source](https://github.com/libtmux/libtmux-ruby/blob/c6d9d21771828e583692ca899ed817f9640d6a55/gems/libtmux-async/lib/libtmux/async.rb#L31)] [¶](#LibTmux::Async "Permalink to Async") modulelibtmux-async \[[source](https://github.com/libtmux/libtmux-ruby/blob/c6d9d21771828e583692ca899ed817f9640d6a55/gems/libtmux-async/lib/libtmux/async.rb#L31)] [¶](#LibTmux::Async "Permalink to Async") Async Other 2 types [Entity 12 members](https://libtmux.org/en/ruby/latest/reference/libtmux-entity-bg78/) [EntityRef 9 members](https://libtmux.org/en/ruby/latest/reference/libtmux-entityref-162n/) A target belongs to one open server binding; names never identify it.