View Source Orbit.Capsule (Orbit v0.2.2)

The main endpoint supervisor.

options

Options

required

Required

  • :endpoint - the Orbit.Pipe entry point that gets called on every request, typically an Orbit.Router

  • One of:

    • :certfile - path to a TLS certificatefile in the PEM format
    • :cert - a DER-encoded certificate binary
    • :cert_pem - a PEM-encoded certificate binary
  • One of:

    • :keyfile - path to a TLS private key file in the PEM format
    • :key - a DER-encoded private key binary
    • :key_pem - a PEM-encoded private key binary

optional

Optional

  • :ip - the IP to listen on; could be :any, :loopback, or an address string; defaults to :any
  • :port - the port to listen on; defaults to 1965

example-child-specification

Example Child Specification

{
  Orbit.Capsule,
  endpoint: MyApp.GemRouter,
  certfile: Path.join(Application.app_dir(:my_app, "priv"), "cert.pem"],
  keyfile: Path.join(Application.app_dir(:my_app, "priv"), "key.pem")
}

Link to this section Summary

Functions

Returns a specification to start this module under a supervisor.

Returns metadata about the capsule's TLS listener.

Link to this section Functions

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

listener_info(capsule_pid)

View Source

Returns metadata about the capsule's TLS listener.