BtrzWebhooksEmitter v0.4.1 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
Response for every function
Functions
Returns a specification to start this module under a supervisor.
Emits messages asynchrounously
Returns always :ok
Emits messages synchrounously
For particular use, try always to use emit/1 if possible.
Returns emit_sync_response :: {:ok, term} | {:error, term}
Sends sync the message to AWS SQS and returns {:ok, result}. If something fails, it will log the error and returns {:error, reason}
Sends async the message to AWS SQS. If something fails, it will just log the error.
Invoked when the server is started. start_link/3
or start/3
will
block until it returns.
Starts a new BtrzWebhooksEmitter process.
Link to this section Types
emit_sync_response() View Source
Response for every function
Link to this section Functions
child_spec(init_arg) View Source
Returns a specification to start this module under a supervisor.
See Supervisor
.
emit(server, message)
View Source
emit(GenServer.server(), map()) :: :ok
emit(GenServer.server(), map()) :: :ok
Emits messages asynchrounously
Returns always :ok
emit_sync(server, message)
View Source
emit_sync(GenServer.server(), map()) :: emit_sync_response()
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) View Source
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) View Source
Sends async the message to AWS SQS. If something fails, it will just log the error.
init(aws_config) View Source
Invoked when the server is started. start_link/3
or start/3
will
block until it returns.
init_arg
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 {:ok, state, {:continue, continue}}
is similar to
{:ok, state}
except that immediately after entering the loop
the c:handle_continue/2
callback will be invoked with the value
continue
as first argument.
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 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 callingSupervisor.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(aws_config, opts \\ []) View Source
Starts a new BtrzWebhooksEmitter process.