Core LibraryalphaAPI Reference

Choose documentation 1

latest

Current version

latest
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

function libtmux-elixir latest

Control.submit/3

Admits one request and returns its retained operation handle.

Source and package
Qualified name
LibTmux.Control.submit/3
Module
LibTmux
Declared in
Control
Package
libtmux
Source
lib/libtmux/control.ex
submit(control, request, options \\ []) @spec submit(t(), LibTmux.Control.Request.t(), [ call_option() ]) :: {:ok, LibTmux.Operation.t()} | {:error, LibTmux.Error.t()}

Description#

timeout defaults to 5000ms and covers validation, admission, queueing, writes and replies under one monotonic deadline. Request binaries are detached before publication. Invalid input, overload or stale context before admission returns a no-write error. Every successful admission returns its Operation, even if its context disappears before publication. Inspect that handle for the eventual canonical result or an explicit lost-context error.

Closing the connection can affect sibling operations. Command replies do not prove external program exit. Caller timeout does not authorize replay.

See the worked example.

Discussed in Read values, execute explicitly · Execution ownership

Esc

Type to search.

Reference preview Open reference