W3cubDocs

/Phoenix

Phoenix.Endpoint.Handler behaviour

API for exporting a webserver.

A handler will need to implement a child_spec/3 function which takes:

  • the scheme of the endpoint :http or :https
  • phoenix top-most endpoint module
  • phoenix app configuration for the specified scheme

It has to return a supervisor child specification.

Summary

Functions

child_spec(arg)

Returns a specification to start this module under a supervisor

Callbacks

child_spec(scheme, endpoint, config)

Provides a server child specification to be started under the endpoint

Functions

child_spec(arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

Callbacks

child_spec(scheme, endpoint, config)

child_spec(scheme :: atom(), endpoint :: module(), config :: Keyword.t()) ::
  Supervisor.Spec.spec()

Provides a server child specification to be started under the endpoint.

© 2014 Chris McCord
Licensed under the MIT License.
https://hexdocs.pm/phoenix/Phoenix.Endpoint.Handler.html