phoenix_pubsub_eventstore v1.1.1 Phoenix.PubSub.EventStore View Source

Phoenix PubSub adapter backed by EventStore. Supervisor module.

An example usage (add this to your supervision tree):

{Phoenix.PubSub.EventStore,
  [name: MyApp.PubSub, eventstore: MyApp.EventStore]}

where MyApp.EventStore is configured separately based on the EventStore documentation.

It is recommended to use a dedicated event store for the purpose of pubsub.

Link to this section Summary

Functions

Returns a specification to start this module under a supervisor.

Start the supervisor

Start the supervisor

Link to this section Functions

Returns a specification to start this module under a supervisor.

See Supervisor.

Start the supervisor

opts is a keyword list containing:

  • name: the name of the PubSub
  • eventstore: the name of a the EventStore module to be used for distributing messages
  • serializer: optional module name for doing the serialization and deserialization of messages. Defaults to Phoenix.PubSub.EventStore.Serializer.Base64

Start the supervisor

  • name is the name of the PubSub
  • opts is a keyword list containing:

    • eventstore: the name of a the EventStore module to be used for distributing messages
    • serializer: optional module name for doing the serialization and deserialization of messages. Defaults to Phoenix.PubSub.EventStore.Serializer.Base64