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.

enum libtmux-dotnet latest

TmuxDispatchState

Namespace LibTmux.TmuxDispatchState LibTmux

Says whether a failed command reached tmux, which is what decides if retrying is safe.

View as Markdown

Source and package
Module
LibTmux
Package
LibTmux
Source
src/LibTmux/Exceptions/TmuxDispatchState.cs
enum LibTmux.TmuxDispatchState
enum [source]

Description#

Retrying is safe only when the command never reached tmux. Unknown is the default because assuming otherwise repeats a side effect tmux already ran.

Discussed in Errors and exceptions

Members3 members#

Common operations3 members#

  • Dispatched constant tmux ran the command and answered. The failure is tmux refusing or reporting an error, not the command going missing, so any side effect it had before failing has already happened.
  • NotDispatched constant The command never reached tmux, so nothing was done and a retry repeats nothing. This is the only state in which retrying is unconditionally safe.
  • Unknown constant Whether tmux acted on the command cannot be determined. Treat a retry as capable of repeating whatever the command does.
Esc

Type to search.