Core LibraryAPI Reference

Choose documentation 3

latest

Current version

latest
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

function LibTmux.jl latest

switch_client

Module LibTmux.switch_client LibTmux
Source and package
Module
LibTmux
Package
LibTmux
Source
src/topology.jl

Methods#

switch_client( connection::LibTmux.ControlConnection, client::LibTmux.ClientRef, session::LibTmux.SessionRef; update_environment, kwargs... )[source]#

Switch the captured client to the exact session on the connected daemon. Recheck its name and observed PID/creation-time incarnation before submission. Client names must be valid UTF-8 without spaces or control bytes because tmux reflects them as unescaped notification fields. update_environment=true copies the client's configured environment variables into the destination session.

switch_client(connection::ControlConnection, client::ClientRef, session::SessionRef;
update_environment=false, kwargs...)

Return ControlResult after the completion fence. The connection pins daemon identity; client incarnation remains observational and can change between the check and mutation. strict=false does not weaken the daemon guard. There is no implicit current client, replay or subprocess fallback.

switch_client( server::LibTmux.Server, client::LibTmux.ClientRef, session::LibTmux.SessionRef; update_environment, kwargs... )[source]#

Switch exactly the captured client to a session. Recheck its name and observed PID/creation-time incarnation before submission. update_environment=true also updates the destination session's environment from the client. Incarnation and generation checks are best effort; strict execution is unsupported.

switch_client(server, client::ClientRef, session::SessionRef;
update_environment=false, kwargs...)
Esc

Type to search.

Reference preview Open reference