Crate sopht

sopht is a program for managing long running processes in a (slightly) more sophisticated way than something like tmux. this library currently implements the IPC protocol sopht uses to pass commands and responses between clients and a server, as well as the machinery required for starting and managing child processes

Structs

• ChangeRestartPolicyArgs
  arguments to State::change_restart_policy
• Connection
  structure containing the state of a connection to the sopht socket
• Process
  contains all information about a running or previously-running process, including the Child structure and the handles to the threads reading the output streams of the process. this structure also maintains a Vec<String> containing all the output lines of its child process. for more info about how this output is read and stored, see Process::start
• ProcessStatus
  detailed status of a Process. this structure is generated by State::status_of
• Response
  represents a response from the server to the client. this should never be received by a server. additionally, this structure is subject to change in the future as responses get more detailed
• SendArgs
  arguments to State::send
• StartArgs
  arguments to State::start
• State
  the state of the sopht process manager. contains all processes started and all other configuration/state

Enums

• Command
  represents a command to be executed by a server. this should never be received by a client.
• Error
  union of all errors resulting from sopht functions. this type implements Display and Error, and is the error type of sopht::Result.
• ExitStatus
  how sopht internally represents the exit status of a process
• Message
  union of all different message types. currently the only two message types are Command and Response. the Command variant should only ever be sent by clients and received by servers, and the Response variant should only ever be received by clients and sent by servers
• RestartPolicy
  describes the conditions under which a process will be restarted in an upkeep cycle. this has no effect on State::restart

Functions

• create_client_connection
  creates a UnixStream and attempts to build a Connection out of it. if the stream cannot be created, this function returns SocketError
• create_local_dirs
  attempts to create the local directories required for sopht
• socket_file_path
  obtains the file path of the unix socket file on the local machine whether it exists or not. this function can fail if the current user has no HOME directory (NoHomeDir)

Type Aliases

• PID
  PIDs are represented internally by a plain usize, though this may change in the future!
• Result
  specialized Result type for return values from sopht functions