Ruby API

method libtmux-ruby v0.1.0.alpha.3

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

def self.new: () -> ::LibTmux::Cancellation method libtmux static [source] ¶

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 4.0.7, Bundler, Git and tmux 3.3a or newer on Unix, with /bin/cat and /bin/sh available. In an empty directory, fetch the documented library revision:

$ git clone https://github.com/libtmux/libtmux-ruby.git libtmux-source && \
  git -C libtmux-source checkout d8ce4bbee0ca7748a81929f81f7d8d07f8c51267

Save this dependency file as Gemfile:

source "https://rubygems.org"

gem "libtmux", path: "libtmux-source/gems/libtmux"

Save this complete program as cancellation.rb. Its Server.start block owns a private tmux server and stops it on exit, including after an error. View source

# frozen_string_literal: true

begin
  # docs:begin main
  require "libtmux"

  LibTmux::Server.start do |server|
    server.new_session(name: "work", command: ["/bin/cat"])
    cancellation = LibTmux::Cancellation.new
    waiting = Thread.new do
      server.run(["wait-for", "-S", "ready", ";", "wait-for", "held"], timeout: 5, cancel: cancellation)
    rescue LibTmux::Cancelled => error
      error
    end
    server.wait_for("ready", timeout: 5)
    cancellation.cancel
    failure = waiting.value
    puts "request: #{failure.class}"
    puts "delivery: #{failure.delivery}"
    cancellation.close
  end
  # docs:end main
rescue StandardError => error
  warn "#{error.class}: #{error.message}"
  exit 1
end

Install the runtime dependencies and run the saved program. An operation or cleanup error makes it exit unsuccessfully:

$ bundle config set --local path vendor/bundle && \
  bundle install --jobs 2 && \
  bundle exec ruby cancellation.rb

Expected output:

request: LibTmux::Cancelled
delivery: possibly_sent

Discussed in Ownership and errors

Scripting & web

Compiled & native

JVM

.NET

tmux

Cancellation.new

Description#

Examples#

Description#

Examples#

Related types#