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.startable_at_socket_path

A socket handle that may create an absent server on its first new_session() call or an explicit run({"start-server"}).

Source and package
Qualified name
libtmux::Server::startable_at_socket_path
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]] static expected<Server, CommandFailure> startable_at_socket_path( std::string_view path, std::optional<std::filesystem::path> configuration, CommandObserver observer = {}, ExecutionPolicy policy = {});template <typename Path> requires std::same_as<std::remove_cvref_t<Path>, std::filesystem::path> [[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]] static expected<Server, CommandFailure> startable_at_socket_path( Path&& path, std::optional<std::filesystem::path> configuration, CommandObserver observer = {}, ExecutionPolicy policy = {});

Description#

configuration is passed to tmux as -f; absent preserves tmux's user configuration. Every other call remains no-start while the socket is absent. The selector and configuration are frozen in the handle, and concurrent first-session calls are serialized.

Type parameters
  • Path # for startable_at_socket_path(path, configuration, observer, policy) [overload 2]

Parameters
Esc

Type to search.

Reference previewOpen reference