lyn v0.0.16 Lyn.Endpoint

Summary

Functions

Returns all sockets configured in this endpoint

broadcast(topic, event, msg)

broadcast!(topic, event, msg)

broadcast_from(from, topic, event, msg)

broadcast_from!(from, topic, event, msg)

call(conn, opts)

Callback implementation for c:Plug.call/2

config(key, default \\ nil)

Returns the endpoint configuration for key

config_change(changed, removed)

Reloads the configuration given the application environment changes

Callback implementation for c:Plug.init/1

Generates the path information when routing to this endpoint

Starts the endpoint supervision tree

static_path(path)

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

subscribe(pid, topic, opts \\ [])

unsubscribe(pid, topic)

url()

Generates the endpoint base URL without any path information

Macros

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

Instruments the given function

Functions

__sockets__()

Returns all sockets configured in this endpoint.

broadcast(topic, event, msg)

broadcast!(topic, event, msg)

broadcast_from(from, topic, event, msg)

broadcast_from!(from, topic, event, msg)

call(conn, opts)

Callback implementation for c:Plug.call/2.

config(key, default \\ nil)

Returns the endpoint configuration for key

Returns default if the key does not exist.

config_change(changed, removed)

Reloads the configuration given the application environment changes.

init(opts)

Callback implementation for c:Plug.init/1.

path(path)

Generates the path information when routing to this endpoint.

start_link()

Starts the endpoint supervision tree.

static_path(path)

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

static_url()

Generates the static URL without any path information.

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

struct_url()

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 to URL helpers.

unsubscribe(pid, topic)

url()

Generates the endpoint base URL without any path information.

It uses the configuration under :url to generate such.

Macros

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

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