Conduit v0.12.10 Conduit.SubscribeRoute View Source

Configuration for a subscribe route

Link to this section Summary

Link to this section Types

Link to this type pipelines() View Source
pipelines() :: [atom()]
Link to this type subscriber() View Source
subscriber() :: module()
Link to this type t() View Source
t() :: %Conduit.SubscribeRoute{
  name: atom(),
  opts: Keyword.t(),
  pipelines: [atom()],
  subscriber: module()
}

Link to this section Functions

Link to this function new(name, subscriber, pipelines \\ [], opts \\ []) View Source
new(name(), subscriber(), pipelines(), opts()) :: t()

Creates a new SubscribeRoute struct

Examples

iex> Conduit.SubscribeRoute.new(
iex>   :user_created,
iex>   MyApp.UserCreatedEmailSubscriber,
iex>   [:in_tracking, :error_handling],
iex>   from: "my_app.created.user")
%Conduit.SubscribeRoute{
  name: :user_created,
  subscriber: MyApp.UserCreatedEmailSubscriber,
  pipelines: [:in_tracking, :error_handling],
  opts: [from: "my_app.created.user"]}
iex> Conduit.SubscribeRoute.new(
iex>   :dynamic,
iex>   MyApp.DynamicSubscriber,
iex>   [:in_tracking],
iex>   fn -> [from: "my_app.dynamic.queue"] end)
%Conduit.SubscribeRoute{
  name: :dynamic,
  subscriber: MyApp.DynamicSubscriber,
  pipelines: [:in_tracking],
  opts: [from: "my_app.dynamic.queue"]}