BtrzWebhooksEmitter v0.3.0 BtrzWebhooksEmitter.SQS View Source

Genserver for emitting events to the configured AWS SQS

If there is no SQS_QUEUE_URL, the GenServer will be started with :ignore and the process will exit normally.

Link to this section Summary

Types

emit_sync_response()

Response for every function

Functions

child_spec(arg)

Returns a specification to start this module under a supervisor

emit(server, message)

Emits messages asynchrounously Returns always :ok

emit_sync(server, message)

Emits messages synchrounously For particular use, try always to use emit/1 if possible. Returns emit_sync_response :: {:ok, term} | {:error, term}

handle_call(msg, from, state)

Sends sync the message to AWS SQS and returns {:ok, result}. If something fails, it will log the error and returns {:error, reason}

handle_cast(msg, state)

Sends async the message to AWS SQS. If something fails, it will just log the error

init(queue_url)

Invoked when the server is started. start_link/3 or start/3 will block until it returns

start_link(params, opts \\ [])

Starts a new BtrzWebhooksEmitter process

Link to this section Types

emit_sync_response()

emit_sync_response() :: {:ok, term()} | {:error, term()}

Response for every function

Link to this section Functions

child_spec(arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

emit(server, message)

emit(GenServer.server(), map()) :: :ok

Emits messages asynchrounously Returns always :ok

emit_sync(server, message)

emit_sync(GenServer.server(), map()) :: emit_sync_response()

Emits messages synchrounously For particular use, try always to use emit/1 if possible. Returns emit_sync_response :: {:ok, term} | {:error, term}

handle_call(msg, from, state)

Sends sync the message to AWS SQS and returns {:ok, result}. If something fails, it will log the error and returns {:error, reason}

handle_cast(msg, state)

Sends async the message to AWS SQS. If something fails, it will just log the error.

init(queue_url)

Invoked when the server is started. start_link/3 or start/3 will block until it returns.

args is the argument term (second argument) passed to start_link/3.

Returning {:ok, state} will cause start_link/3 to return {:ok, pid} and the process to enter its loop.

Returning {:ok, state, timeout} is similar to {:ok, state} except handle_info(:timeout, state) will be called after timeout milliseconds if no messages are received within the timeout.

Returning {:ok, state, :hibernate} is similar to {:ok, state} except the process is hibernated before entering the loop. See c:handle_call/3 for more information on hibernation.

Returning :ignore will cause start_link/3 to return :ignore and the process will exit normally without entering the loop or calling c:terminate/2. If used when part of a supervision tree the parent supervisor will not fail to start nor immediately try to restart the GenServer. The remainder of the supervision tree will be (re)started and so the GenServer should not be required by other processes. It can be started later with Supervisor.restart_child/2 as the child specification is saved in the parent supervisor. The main use cases for this are:

The GenServer is disabled by configuration but might be enabled later.
An error occurred and it will be handled by a different mechanism than the Supervisor. Likely this approach involves calling Supervisor.restart_child/2 after a delay to attempt a restart.

Returning {:stop, reason} will cause start_link/3 to return {:error, reason} and the process to exit with reason reason without entering the loop or calling c:terminate/2.

Callback implementation for GenServer.init/1.

start_link(params, opts \\ [])

Starts a new BtrzWebhooksEmitter process.