NAME

LibTmux::Async::Server - Optional Future facade over the core protocol

SYNOPSIS

use v5.44;
use IO::Async::Loop::Ppoll;
use LibTmux::Async::Server;
my $loop = IO::Async::Loop::Ppoll->new;
my $server = LibTmux::Async::Server->new(loop => $loop, socket_name => 'owned');
my $capture = $server->snapshot;
$loop->await($capture);
my $panes = $capture->get->panes->where({ active => true });
$loop->await($server->close);

METHODS

new

new(loop => $loop, %connection_options) constructs without I/O. Borrow an IO::Async::Loop::Ppoll; connection options belong to "new" in LibTmux::Server. max_concurrent and max_queue configure the owned LibTmux::Async::Transport. Its backend and signal contract applies to this facade. No event loop is run implicitly.

close

Cancel active operations, suppress subsequent command continuations, reject new operations, and return a fresh cleanup observer Future. Only successful is_done completion proves owned processes and pipes finished. Cancellation of an observer does not cancel cleanup. The caller must drive its borrowed loop through shutdown. No tmux server is destroyed by closing this facade.

CORE OPERATIONS

Each operation below returns a Future yielding exactly one value with the corresponding core method's result and error contract. Void core methods yield one undef. Failures contain the original typed core exception. Preparation and result parsing use LibTmux::Operation; no blocking core operation runs inside the event loop. Captured LibTmux::Selection filtering stays local. Cancelling a Future requests process cleanup and prevents later requests; it cannot reverse already accepted mutations. Independent operations may overlap; batch requests remain ordered. Future::AsyncAwait is optional caller syntax.

execute

See "execute" in LibTmux::Server for arguments, returned value, and completion.

cmd

See "cmd" in LibTmux::Server for arguments, returned value, and completion.

new_session

See "new_session" in LibTmux::Server for arguments, returned value, and completion.

new_window

See "new_window" in LibTmux::Server for arguments, returned value, and completion.

split_pane

See "split_pane" in LibTmux::Server for arguments, returned value, and completion.

snapshot

See "snapshot" in LibTmux::Server for arguments, returned value, and completion.

listings

See "listings" in LibTmux::Server for arguments, returned value, and completion.

query_panes

See "query_panes" in LibTmux::Server for arguments, returned value, and completion. Its observer runs inline in void context; a returned Future is ignored. Cancellation before the decision suppresses it. If the observer cancels its query or calls "close", cancellation takes precedence over subsequent return or exception delivery. Continue driving the loop until close cleanup completes.

explain_panes

See "explain_panes" in LibTmux::Server for arguments, returned value, and completion.

rename_session

See "rename_session" in LibTmux::Server for arguments, returned value, and completion.

rename_window

See "rename_window" in LibTmux::Server for arguments, returned value, and completion.

See "link_window" in LibTmux::Server for arguments, returned value, and completion.

See "unlink_window" in LibTmux::Server for arguments, returned value, and completion.

move_window

See "move_window" in LibTmux::Server for arguments, returned value, and completion.

select_window

See "select_window" in LibTmux::Server for arguments, returned value, and completion.

select_pane

See "select_pane" in LibTmux::Server for arguments, returned value, and completion.

select_layout

See "select_layout" in LibTmux::Server for arguments, returned value, and completion.

resize_pane

See "resize_pane" in LibTmux::Server for arguments, returned value, and completion.

set_title

See "set_title" in LibTmux::Server for arguments, returned value, and completion.

send_keys

See "send_keys" in LibTmux::Server for arguments, returned value, and completion.

send_text

See "send_text" in LibTmux::Server for arguments, returned value, and completion.

capture_pane

See "capture_pane" in LibTmux::Server for arguments, returned value, and completion.

kill_pane

See "kill_pane" in LibTmux::Server for arguments, returned value, and completion.

kill_window

See "kill_window" in LibTmux::Server for arguments, returned value, and completion.

kill_session

See "kill_session" in LibTmux::Server for arguments, returned value, and completion.

kill_server

See "kill_server" in LibTmux::Server for arguments, returned value, and completion.

clients

See "clients" in LibTmux::Server for arguments, returned value, and completion.

attach_argv

See "attach_argv" in LibTmux::Server for arguments, returned value, and completion.

detach_client

See "detach_client" in LibTmux::Server for arguments, returned value, and completion.

set_option

See "set_option" in LibTmux::Server for arguments, returned value, and completion.

get_option

See "get_option" in LibTmux::Server for arguments, returned value, and completion.

unset_option

See "unset_option" in LibTmux::Server for arguments, returned value, and completion.

set_hook

See "set_hook" in LibTmux::Server for arguments, returned value, and completion.

show_hooks

See "show_hooks" in LibTmux::Server for arguments, returned value, and completion.

set_environment

See "set_environment" in LibTmux::Server for arguments, returned value, and completion.

get_environment

See "get_environment" in LibTmux::Server for arguments, returned value, and completion.

unset_environment

See "unset_environment" in LibTmux::Server for arguments, returned value, and completion.

set_buffer

See "set_buffer" in LibTmux::Server for arguments, returned value, and completion.

show_buffer

See "show_buffer" in LibTmux::Server for arguments, returned value, and completion.

delete_buffer

See "delete_buffer" in LibTmux::Server for arguments, returned value, and completion.

batch

See "batch" in LibTmux::Server for arguments, returned value, and completion.