Core LibraryalphaAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

method libtmux-cxx latest

Server.try_submit

Admit one command to an explicit bounded runtime without waiting for it.

Source and package
Qualified name
libtmux::Server::try_submit
Namespace
libtmux
Declared in
Server
Package
libtmux-cxx
Source
include/libtmux/server.hpp
[[C++ nodiscard attributeAsks the compiler to warn when a result is discarded. An explicit cast to void acknowledges that the result is intentionally ignored.Language documentation]] expected<CommandOperation, CommandFailure> try_submit( CommandRuntime& runtime, CommandRequest command, std::optional<std::chrono::milliseconds> timeout = {}, std::optional<std::size_t> output_limit = {}) const;

Description#

A refusal before admission is returned here; an admitted command carries every later transport or tmux failure in its operation.

Admission does not wait for a slot, but the daemon's release is asked before it. A submission to an endpoint whose daemon has not answered yet can block the calling thread on that probe, up to the command's timeout. An empty command is a validation error.

Esc

Type to search.

Reference previewOpen reference