On this page
TmuxServers.discover(in:tmuxExecutable:)
- Declared in
- TmuxServers
- Package
- libtmux-swift
- Source
- Sources/LibTmux/Discovery.swift
- discover(in:tmuxExecutable:) ( in : [String]? , tmuxExecutable : String ) ServerDiscovery
-
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.
- directories: where to look. Defaults to
- Returns: At most 128 reachable servers and whether the scan stopped before exhausting entries or candidates.
- Throws:
TmuxError/cancelledwhen the calling task is cancelled.
- Raises
- Parameters:
0 declared, 0 inherited