Pleroma v1.1.9-10-g42f76306+dev Pleroma.Web.Endpoint View Source

Link to this section Summary

Functions

Broadcasts a msg as event in the given topic.

Broadcasts a msg as event in the given topic.

Broadcasts a msg from the given from as event in the given topic.

Broadcasts a msg from the given from as event in the given topic.

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.

Dynamically loads configuration from the system environment on startup.

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.

Unsubscribes the caller from the given topic.

Generates the endpoint base URL without any path information.

Link to this section Functions

Link to this function

broadcast(topic, event, msg)

View Source

Broadcasts a msg as event in the given topic.

Callback implementation for Phoenix.Endpoint.broadcast/3.

Link to this function

broadcast!(topic, event, msg)

View Source

Broadcasts a msg as event in the given topic.

Raises in case of failures.

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

Link to this function

broadcast_from(from, topic, event, msg)

View Source

Broadcasts a msg from the given from as event in the given topic.

Callback implementation for Phoenix.Endpoint.broadcast_from/4.

Link to this function

broadcast_from!(from, topic, event, msg)

View Source

Broadcasts a msg from the given from as event in the given topic.

Raises in case of failures.

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

Callback implementation for Plug.call/2.

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

Link to this function

config(key, default \\ nil)

View Source

Returns the endpoint configuration for key

Returns default if the key does not exist.

Link to this function

config_change(changed, removed)

View Source

Reloads the configuration given the application environment changes.

Returns the host for the given endpoint.

Callback implementation for Plug.init/1.

Link to this macro

instrument(event, runtime \\ Macro.escape(%{}), fun)

View Source (macro)

Instruments the given function.

event is the event identifier (usually an atom) that specifies which instrumenting function to call in the instrumenter modules. runtime is metadata to be associated with the event at runtime (e.g., the query being issued if the event to instrument is a DB query).

Examples

instrument :render_view, %{view: "index.html"}, fn ->
  render(conn, "index.html")
end
Link to this function

load_from_system_env(config)

View Source

Dynamically loads configuration from the system environment on startup.

It receives the endpoint configuration from the config files and must return the updated configuration.

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.

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(pid, topic, opts)

View Source

Unsubscribes the caller from the given topic.

Callback implementation for Phoenix.Endpoint.unsubscribe/1.

Generates the endpoint base URL without any path information.

It uses the configuration under :url to generate such.