Cancellation.new
Behavior: Cancellation tokens.
Source and package
- Qualified name
-
LibTmux:: Cancellation. new - Module
- LibTmux
- Declared in
Cancellation- Package
- libtmux
- Source
- gems/libtmux/lib/libtmux/process.rb
-
Description#
Behavior contract: Cancellation tokens.
Examples#
Wake a blocked request from another thread with a cancellation token and read the delivery evidence on the Cancelled error. 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", "0.1.1"Save this complete program as
cancellation.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"LibTmux::Server.start do |server|server.new_session(name: "work", command: ["/bin/cat"])cancellation = LibTmux::Cancellation.newwaiting = Thread.new doserver.run(["wait-for", "-S", "ready", ";", "wait-for", "held"], timeout: 5, cancel: cancellation)rescue LibTmux::Cancelled => errorerrorendserver.wait_for("ready", timeout: 5)cancellation.cancelfailure = waiting.valueputs "request: #{failure.class}"puts "delivery: #{failure.delivery}"cancellation.closeend# 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 cancellation.rbExpected output:
request: LibTmux::Cancelleddelivery: possibly_sent
Guides#
Pages that discuss new.