Server.open_control
Behavior: Control connections.
Source and package
- Qualified name
-
LibTmux:: Async:: Server# open _control - Module
- LibTmux::Async
- Declared in
Server- Package
- libtmux-async
- Source
- gems/libtmux-async/lib/libtmux/async/server.rb
- def open_control: [T] ( session: ::Lib
Tmux:: , ?reconnect: ::LibEntity Ref Tmux:: ?, **::Integer ) { (::LibControl Connection Tmux:: ) -> T } -> Tdef open_control: ( session: ::LibAsync:: Control Connection Tmux:: , ?reconnect: ::LibEntity Ref Tmux:: ?, **::Integer ) -> ::LibControl Connection Tmux:: Async:: Control Connection -
Description#
Behavior contract: Control connections.
Examples#
Open a control connection inside an Async scope and read the notification tmux sends when a window is renamed. Use Ruby 3.3 or newer with Bundler, and tmux 3.3a or newer, on Unix with
/bin/catand/bin/shavailable. In an empty directory, save thisGemfile:source "https://rubygems.org"gem "libtmux-async", "0.1.1"Save this complete program as
async_control.rb. ItsServer.start()block owns a private tmux server and stops it on exit, including after an error. View source# frozen_string_literal: truebegin# docs:begin mainrequire "libtmux"require "libtmux/async"LibTmux::Server.start do |server|session = server.new_session(name: "work", command: ["/bin/cat"])window = session.list_windows.fetch(0)Async do |parent|LibTmux::Async.open(parent: parent, server: server) do |scope|scope.server.open_control(session: session.ref) do |control|reply = control.exchange("display-message -p ready", timeout: 5)puts "reply: #{reply.blocks.last.body.strip}"events = control.eventswindow.rename("renamed")event = events.next(timeout: 5) until event&.raw&.start_with?("%window-renamed")puts "event: #{event.raw.strip}"endendend.waitend# docs:end mainrescue StandardError => errorwarn "#{error.class}: #{error.message}"exit 1endInstall the gem and run the program. An operation or cleanup error makes it exit unsuccessfully:
Terminal window $ bundle install && \bundle exec ruby async_control.rbExpected output:
reply: readyevent: %window-renamed @0 renamed- Type parameters
- Parameters
-