View Source Pigeon.Configurable protocol (Pigeon v1.6.3)

Summary

Types

sock()

t()

All the types that implement this protocol.

Functions

close(config)

connect(config)

handle_end_stream(config, stream, notification, on_response)

max_demand(config)

push_headers(config, notification, opts)

push_payload(config, notification, opts)

schedule_ping(config)

Schedules connection ping if necessary.

validate!(config)

worker_name(config)

Returns worker name for config.

Types

sock()

@type sock() :: {:sslsocket, any(), pid() | {any(), any()}}

t()

@type t() :: term()

All the types that implement this protocol.

Functions

close(config)

connect(config)

@spec connect(any()) :: {:ok, sock()} | {:error, String.t()}

handle_end_stream(config, stream, notification, on_response)

max_demand(config)

@spec max_demand(any()) :: non_neg_integer()

push_headers(config, notification, opts)

push_payload(config, notification, opts)

schedule_ping(config)

@spec schedule_ping(any()) :: no_return()

Schedules connection ping if necessary.

Examples

iex> schedule_ping(%Pigeon.APNS.Config{ping_period: 2})
iex> receive do
...>   :ping -> "Got ping!"
...> after
...>   5000 -> "No ping received."
...> end
"Got ping!"

iex> schedule_ping(%Pigeon.FCM.Config{})
iex> receive do
...>   :ping -> "Got ping!"
...> after
...>   5000 -> "No ping received."
...> end
"No ping received."

validate!(config)

@spec validate!(any()) :: :ok | no_return()

worker_name(config)

@spec worker_name(any()) :: atom() | nil

Returns worker name for config.

Examples

iex> worker_name(%Pigeon.APNS.Config{name: :test})
:test

iex> worker_name(%Pigeon.FCM.Config{name: :another})
:another