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.

interface libtmux-java latest

ServerEndpoint

Which tmux server to talk to.

Source and package
Qualified name
io.github.libtmux.ServerEndpoint
Package
io.github.libtmux
Distribution
io.github.libtmux:libtmux
Source
libtmux/src/main/java/io/github/libtmux/ServerEndpoint.java
interface io.github.libtmux.ServerEndpoint

Description#

A value, decided and comparable before any process runs. Two endpoints are equal when they name the same server lexically; nothing here resolves symlinks, contacts the filesystem, or opens a socket. That matters because an endpoint is routinely built, logged and compared while the socket it names does not exist yet.

Validation that needs tmux — above all whether a socket path fits the platform's sun_path — happens at dispatch, where the error can carry the command that hit it.

Members8#

Common operations3#

  • defaultSocket method tmux's own default server, wherever tmux decides that is.
  • namedSocket method A server named with -L, resolved by tmux under its own socket directory.
  • socketPath method A server at an exact socket path, selected with -S.

Other members5#

  • Default class Adds no flags, so tmux applies its own default socket resolution.
  • flags method The flags that select this server, in argv order.
  • fromEnvironment method The server an environment names, or tmux's own default when it names none.
  • NamedSocket class A server tmux locates by name under its own socket directory.
  • SocketPath class A server at an exact socket path.
Esc

Type to search.

Reference previewOpen reference