ace v0.9.2 Ace.TLS

TLS endpoint for secure connections to a service.

An endpoint is started with a application definition(Ace.Application) and configuration.

Each client connection is handle by an individual server.

Link to this section Summary

Types

Option values used to start an endpoint

Configuration options used when starting and endpoint

Functions

Retrieve the port number for an endpoint

Start a secure endpoint with the service

Link to this section Types

Link to this type option()
option ::
  {:name, GenServer.name} |
  {:acceptors, non_neg_integer} |
  {:port, :inet.port_number}

Option values used to start an endpoint.

Link to this type options()
options() :: [option]

Configuration options used when starting and endpoint.

Link to this section Functions

Retrieve the port number for an endpoint.

Link to this function start_link(arg, options)
start_link(app, options) :: {:ok, endpoint} when app: app, endpoint: Ace.TCP.Endpoint.endpoint, options: Ace.TCP.Endpoint.options

Start a secure endpoint with the service.

Options

  • :certificate - required, the certificate.

  • :certificate_key - required, the private key used to sign the certificate request.

  • :port - the port to run the server on. Defaults to port 8443.

  • :name - name to register the spawned endpoint under. The supported values are the same as GenServers.

  • :acceptors - The number of servers simultaneously waiting for a connection. Defaults to 50.