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.

class libtmux-dotnet latest

TmuxWaitChannel

Namespace LibTmux.TmuxWaitChannel LibTmux

An open wait on a tmux wait-for channel.

View as Markdown

Source and package
Module
LibTmux
Package
LibTmux
Source
src/LibTmux/Waiting/TmuxWaitChannel.cs
class LibTmux.TmuxWaitChannel
class [source]

Description#

tmux gives a signal to whoever is registered on the channel and raises the channel's pending flag only when nobody is. A waiter whose client dies stays registered — tmux clears waiters when the server exits and at no other time — so it goes on eating signals that can no longer reach anybody. Killing a waiting client to enforce a timeout therefore destroys the next signal, and each timed-out retry leaves another corpse to destroy the one after that.

WaitAsync returning false means that attempt expired without observing completion. The open wait remains owned and may already have completed from a racing signal. Closing attempts withdrawal before ending the local client; failed withdrawal leaves remote registration unknown.

Discussed in Pane interaction , Waiting and retrying

Members5 members#

Common operations1 member#

  • WaitAsync method Waits for the signal, giving this attempt a budget.

Other members4 members#

  • Channel property Gets the channel being waited on.
  • CloseAsync method Withdraws the waiter and ends its owned client lifetime.
  • DisposeAsync method Withdraws the waiter from tmux.
  • Signalled property Gets whether the wait completed before withdrawal began.
Esc

Type to search.