Core LibraryunreleasedAPI Reference

Choose documentation 2

latest

Current version

latest
English

Unreleased libtmux has not been released. Its API may change during development. This site's structure and URLs may change too.

module libtmux-ocaml latest

Libtmux.Endpoint

An explicit socket description. Constructing an endpoint neither reads the environment nor starts a daemon. Source.t adds the observed daemon and connection generation.

Source and package
Qualified name
Libtmux.Endpoint
Declared in
Libtmux
Package
libtmux
Source
lib/libtmux.mli
module Endpoint

Public owner: Libtmux

Members7#

Common operations2#

  • named_socket function named_socket name describes tmux's -L name endpoint. Raises Invalid_argument if name is empty or contains NUL or /.
  • socket_path function socket_path path describes an absolute -S path endpoint. It does not check existence or resolve symbolic links. Raises Invalid_argument if path is relative, empty or contains NUL.

Other members5#

  • equal function Equality compares descriptions, not server instances or resolved paths.
  • kind function
  • kind enum
  • pp function
  • t typealias An explicit socket description, independent of the environment.
Esc

Type to search.

Reference previewOpen reference