View Source GRPC.Server.Supervisor (grpc v0.8.1)

A simple supervisor to start your servers.

You can add it to your OTP tree as below. To start the server, you can pass start_server: true and an option

defmodule Your.App do
  use Application

  def start(_type, _args) do
    children = [
      {GRPC.Server.Supervisor, endpoint: Your.Endpoint, port: 50051, start_server: true, ...}]

    Supervisor.start_link(children, strategy: :one_for_one, name: __MODULE__)
  end
end

Summary

Types

sup_flags()

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

child_spec(endpoint_or_servers, port, opts \\ [])

Return a child_spec to start server.

init(opts)

Options

:endpoint - defines the endpoint module that will be started.
:port - the HTTP port for the endpoint.
:servers - the list of servers that will be be started.

Either :endpoint or :servers must be present, but not both.

start_link(endpoint)

Types

sup_flags()

@type sup_flags() :: %{
  strategy: Supervisor.strategy(),
  intensity: non_neg_integer(),
  period: pos_integer(),
  auto_shutdown: Supervisor.auto_shutdown()
}

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

child_spec(endpoint_or_servers, port, opts \\ [])

@spec child_spec(
  endpoint_or_servers :: atom() | [atom()],
  port :: integer(),
  opts :: keyword()
) ::
  Supervisor.Spec.spec()

Return a child_spec to start server.

Options

:cred - a credential created by functions of GRPC.Credential, an insecure server will be created without this option
:start_server - determines if the server will be started. If present, has more precedence then the config :gprc, :start_server config value (i.e. start_server: false will not start the server in any case).

init(opts)

@spec init(tuple()) :: no_return()

@spec init(keyword()) :: {:ok, {sup_flags(), [Supervisor.child_spec()]}} | :ignore

Options

:endpoint - defines the endpoint module that will be started.
:port - the HTTP port for the endpoint.
:servers - the list of servers that will be be started.

Either :endpoint or :servers must be present, but not both.