Libmention.Supervisor (libmention v0.1.0)

Responsible for managing send and receive jobs.

Put this in your supervision tree to start the processes of sending and/or receiving webmentions.

opts = [
  outgoing: [],
  incoming: []
]

children = [
  ...,
  {Libmention.Supervisor, opts}
]

options

Options

A keyword list of options is accepted for configuring one or both of

  • incoming webmentions (See "Incoming Opts" section)
  • outgoing webmentions (See "Outgoing Opts" section)

incoming-opts

Incoming opts

outgoing-opts

Outgoing opts

If you desire to send webmentions from your site, an outgoing key should be configured which takes it's own keyword list of options.

outgoing: [
  user_agent: "",
  storage: Libmention.EtsStorage
]

Options include:

  • user_agent - Customize the HTTP User Agent used when fetching the target URL. Defaults to "libmention-Webmention-Discovery"
  • storage - The storage behaviour module to use when sending webmentions. Defaults to Libmention.EtsStorage. See Libmention.StorageApi for more options.

Link to this section Summary

Functions

Returns a specification to start this module under a supervisor.

Starts a process that parses, validates and sends webmentions.

Link to this section Functions

Link to this function

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

send(url, html)

Starts a process that parses, validates and sends webmentions.

Link to this function

start_link(init_arg)