Core LibraryunreleasedAPI Reference

Choose documentation 1

latest

Current version

latest
English

Unreleased libtmux_erlang has not been released. Its API may change during development. This site's structure and URLs may change too.

function libtmux-erlang latest

tmux_server:stop_owned/1

Stop the daemon and endpoint associated with a ownership/0 token. Performs I/O and returns ok only after endpoint/client/helper retirement and namespace cleanup are proved. It never sends kill-server to a socket path.

Source and package
Qualified name
tmux_server:stop_owned/1
Declared in
tmux_server
Package
libtmux_erlang
Source
apps/libtmux_erlang/src/tmux_server.erl
Other languages
Perlmethod PowerShell Julia Elixir Haskell Common Lisp PythonRuby Lua TypeScriptRustGoJavaC#C++SwiftKotlinScala OCaml F# Clojure
stop_owned(Ownership) -spec stop_owned(ownership()) -> ok | {error, map()}.

Description#

A replaced socket/directory or unexpected directory contents are preserved and return cleanup_incomplete with process and namespace details. A supervised tombstone retains uncertain cleanup; call again to inspect/retry after external repair. Filesystem identity checks are observations, not atomic reservations against another trusted process replacing a path during unlink.

Successful stop is idempotent during the 60-second token retention period. After token expiry or application shutdown, returns ownership_expired. Stop explicitly before application shutdown when the caller needs a verified cleanup result. OTP application shutdown itself does not prove native cleanup. Incomplete shutdown writes a private recovery report outside the owned socket directory and logs its location or write failure; no automatic recovery runs.

Parameters

Guides#

Pages that discuss stop_owned/1.

In other ports#

Shut the tmux server down

Equivalents of Shut the tmux server down in other languages
Language Equivalent
Python libtmux.Server.kill
Ruby LibTmux::Server#kill
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript server.Server.kill
Rust server.Server.kill
Go tmux.Server.Kill
Java io.github.libtmux.Server.killServer
Clojure libtmux.core/kill-server!
Kotlin io.github.libtmux.kotlin.Server.killServer
Scala io.github.libtmux.scaladsl.Server.killServer
C# LibTmux.Server.KillAsync
C++ libtmux::Server::kill
Swift Server.killServer()
OCaml Client.close releases transport resources. The public client API does not terminate a borrowed tmux daemon.
Perl LibTmux::Server::kill_server Explicit Server operation. Captured entities remain local observations; use a new snapshot to observe changes.

No equivalent is recorded in Lua, PowerShell, Julia, Elixir, Common Lisp or F#.

Esc

Type to search.

Reference previewOpen reference