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

TmuxServers.discover(in:tmuxExecutable:)

Swift
  • Python Unavailable
  • Ruby Unavailable
  • Lua Unavailable
  • TypeScript Unavailable
  • Rust Unavailable
  • Go Unavailable
  • Java Unavailable
  • .NET Unavailable
  • C++ Unavailable
  • Swift

View as Markdown

Declared in
TmuxServers
Package
libtmux-swift
Source
Sources/LibTmux/Discovery.swift
discover(in:tmuxExecutable:) ( in : [String]? , tmuxExecutable : String ) → ServerDiscovery
methodasyncstatic [source]
methodasyncstatic [source]
discover(in:tmuxExecutable:)

Every server listening on a socket in directories.

A socket file is not a running server: tmux leaves the file behind when it exits, so each candidate is asked whether it answers. One that does not answer within two seconds is left out rather than reported as an empty server. At most eight candidates are asked at once.

  • Parameters:
    • directories: where to look. Defaults to defaultDirectories(environment:).
    • tmuxExecutable: the tmux to ask with.
  • Returns: At most 128 reachable servers and whether the scan stopped before exhausting entries or candidates.
  • Throws: TmuxError/cancelled when the calling task is cancelled.
Raises

0 declared, 0 inherited

Esc

Type to search.