HistoryWeb.Endpoint (history v0.0.15)

Link to this section Summary

Functions

Callback implementation for Plug.call/2.

Returns the child specification to start the endpoint under a supervision tree.

Returns the endpoint configuration for key

Reloads the configuration given the application environment changes.

Returns the host for the given endpoint.

Callback implementation for Plug.init/1.

Generates the path information when routing to this endpoint.

Generates the script name.

Starts the endpoint supervision tree.

Generates a base64-encoded cryptographic hash (sha512) to a static file in priv/static. Meant to be used for Subresource Integrity with CDNs.

Returns a two item tuple with the first item being the static_path and the second item being the static_integrity.

Generates a route to a static file in priv/static.

Generates the static URL without any path information.

Generates the endpoint base URL but as a URI struct.

Generates the endpoint base URL without any path information.

Link to this section Functions

Link to this function

broadcast(topic, event, msg)

Callback implementation for Phoenix.Endpoint.broadcast/3.

Link to this function

broadcast!(topic, event, msg)

Callback implementation for Phoenix.Endpoint.broadcast!/3.

Link to this function

broadcast_from(from, topic, event, msg)

Callback implementation for Phoenix.Endpoint.broadcast_from/4.

Link to this function

broadcast_from!(from, topic, event, msg)

Callback implementation for Phoenix.Endpoint.broadcast_from!/4.

Link to this function

call(conn, opts)

Callback implementation for Plug.call/2.

Link to this function

child_spec(opts)

Returns the child specification to start the endpoint under a supervision tree.

Link to this function

config(key, default \\ nil)

Returns the endpoint configuration for key

Returns default if the key does not exist.

Link to this function

config_change(changed, removed)

Reloads the configuration given the application environment changes.

Returns the host for the given endpoint.

Callback implementation for Plug.init/1.

Link to this function

local_broadcast(topic, event, msg)

Callback implementation for Phoenix.Endpoint.local_broadcast/3.

Link to this function

local_broadcast_from(from, topic, event, msg)

Callback implementation for Phoenix.Endpoint.local_broadcast_from/4.

Generates the path information when routing to this endpoint.

Generates the script name.

Link to this function

start_link(opts \\ [])

Starts the endpoint supervision tree.

Options

  • :log_access_url - if the access url should be logged once the endpoint starts

All other options are merged into the endpoint configuration.

Link to this function

static_integrity(path)

Generates a base64-encoded cryptographic hash (sha512) to a static file in priv/static. Meant to be used for Subresource Integrity with CDNs.

Link to this function

static_lookup(path)

Returns a two item tuple with the first item being the static_path and the second item being the static_integrity.

Link to this function

static_path(path)

Generates a route to a static file in priv/static.

Generates the static URL without any path information.

It uses the configuration under :static_url to generate such. It falls back to :url if :static_url is not set.

Generates the endpoint base URL but as a URI struct.

It uses the configuration under :url to generate such. Useful for manipulating the URL data and passing it to URL helpers.

Link to this function

subscribe(topic, opts \\ [])

Link to this function

unsubscribe(topic)

Generates the endpoint base URL without any path information.

It uses the configuration under :url to generate such.