Sidecar v0.2.0 Sidecar.Process View Source

Supervises a single sidecar process

It is recommended one uses Sidecar.Supervisor to run sidecar processes, rather than using this module manually.

Link to this section Summary

Types

Options used to start a sidecar process

Functions

Start a supervised sidecar process.

Link to this section Types

Specs

init_opts() :: [name: atom(), command: String.t() | (() -> String.t())]

Options used to start a sidecar process

  • name An identifier for the process
  • command The command to run, which is passed to Port.open/2 using {:spawn, command}. If the command is a function, the function is evaluated just before the sidecar process is started. Its return value will be the command.

Link to this section Functions

Specs

start_link(init_opts()) :: GenServer.on_start()

Start a supervised sidecar process.