Pigeon v2.0.0-rc.1

View Source Pigeon.Adapter behaviour (Pigeon v2.0.0-rc.1)

Adapter behaviour for Pigeon.Dispatcher push workers.

Pigeon.Adapter closely resembles GenServer behaviour, as dispatchers are GenServers under the hood.

example-adapter

 Example Adapter 

defmodule Pigeon.Sandbox do
  import Pigeon.Tasks, only: [process_on_response: 1]

  @behaviour Pigeon.Adapter

  @impl true
  def init(opts \ []) do
    {:ok, opts}
  end

  @impl true
  def handle_info(_msg, state) do
    {:noreply, state}
  end

  @impl true
  def handle_push(%{response: nil} = notification, state) do
    process_on_response(%{notification | response: :success})
    {:noreply, state}
  end

  def handle_push(notification, state) do
    process_on_response(notification)
    {:noreply, state}
  end
end

Link to this section Summary

Callbacks

handle_info(term, term)

Invoked to handle all other messages.

handle_push(notification, state)

Invoked to handle push notifications.

init(opts)

Invoked when the server is started.

Link to this section Callbacks

Link to this callback

handle_info(term, term)

View Source 
@callback handle_info(term(), term()) :: {:noreply, term()}

Invoked to handle all other messages.

Link to this callback

handle_push(notification, state)

View Source 
@callback handle_push(notification :: struct() | [struct()], state :: term()) ::
  {:noreply, new_state :: term()}
  | {:stop, reason :: term(), new_state :: term()}

Invoked to handle push notifications.

Link to this callback

init(opts)

View Source 
@callback init(opts :: Keyword.t()) :: {:ok, any()} | {:stop, any()}

Invoked when the server is started.

Return value should be {:ok, state} for the Pigeon.Dispatcher state, or {:stop, atom} if started with invalid configuration options.