Wayfarer.Listener (wayfarer v0.6.4)

View Source

A GenServer which manages the state of each Bandit listener.

You should not need to create one of these yourself, instead use it via Wayfarer.Server.

Options

  • :scheme - Required. The connection protocol. Valid values are :http, :https

  • :port - Required. The TCP port to listen on for connections. Valid values are between 1 and 65535

  • :address (struct of type IP.Address) - Required. The IP address of an interface to bind to.

  • :drain_timeout (pos_integer/0) - How long to wait for existing connections to complete on shutdown. The default value is 60000.

  • :module (module that adopts Wayfarer.Server) - Required. The proxy module this listener is linked to.

  • :name - An optional name for the listener.

  • :keyfile - The path to the SSL secret key file.

  • :certfile - The path to the SSL certificate file

  • :cipher_suite - Used to define a pre-selected set of ciphers, as described by Plug.SSL.configure/1. Valid values are nil, :strong, :compatible

  • :http_1_options (keyword/0) - See Bandit.http_1_options/0.

  • :http_2_options (keyword/0) - See Bandit.http_2_options/0.

  • :websocket_options (keyword/0) - See Bandit.websocket_options/0.

  • :thousand_island_options (keyword/0) - See ThousandIsland.options/0

Summary

Functions

Returns a specification to start this module under a supervisor.

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.