Core Library0.xAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

method libtmux-go latest

Server.CheckAlive

CheckAlive returns a CommandError when the configured server is not alive. Cancellation and transport failures are returned directly. Use Server.IsAlive where an absent server is an answer rather than a failure.

Source and package
Qualified name
tmux.Server.CheckAlive
Package
tmux
Declared in
Server
Distribution
github.com/libtmux/libtmux-go/tmux
Source
tmux/server.go
Other languages
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby Lua TypeScript Rust JavaC# C++ Swift Kotlin Scala OCaml F# Clojure
func (s Server) CheckAlive(ctx context.Context) error
Parameters

tmux command#

The tmux commands behind CheckAlive.

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

Fail unless the server is answering

Equivalents of Fail unless the server is answering in other languages
Language Equivalent
Python libtmux.Server.raise_if_dead
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript server.Server.raiseIfDead
Rust no equivalent on Server
Java io.github.libtmux.Server.requireAlive
C# LibTmux.Server.ThrowIfDeadAsync
C++ no equivalent on Server
Swift no equivalent on Server
OCaml No direct public OCaml equivalent is recorded for this operation.
Perl Explicit acquisition already propagates typed operational failures.

No equivalent is recorded in Ruby, Lua, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.

Esc

Type to search.

Reference previewOpen reference