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.

class libtmux-java latest

Client

One attached tmux client, as one capture saw it.

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

Description#

Identity is the server and the client name, which is how tmux addresses it. What it is attached to is state: a client can switch sessions without becoming a different client.

#name(), #session(), and #attachment() return what the capture holds and do no I/O; #refresh() reads again. Every other method asks tmux now.

Members15#

Parent objects2#

  • session method The session this client was attached to when captured. A pure read of the capture.
  • server method The server this client is connected to.

Other members13#

  • attachment method What this client was looking at when captured. A pure read: it issues no command.
  • Client method
  • detach method Detaches this client, leaving whatever it was attached to running.
  • detachOthers method Detaches every other client, leaving this one attached.
  • equals method
  • fetchAttachment method Takes a new capture and returns what this client is looking at now.
  • hashCode method
  • name method The client's terminal name, which is how tmux addresses it.
  • redraw method Asks tmux to redraw this client.
  • refresh method Takes a new capture and returns this client as it is now.
  • snapshot method
  • switchTo method Moves this client to another session.
  • toString method

Guides#

Pages that discuss Client.

Esc

Type to search.

Reference previewOpen reference