roger v2.1.0 Roger.Partition.Worker View Source
Handles the decoding and execution of a single job.
Besides running the job, various administrative tasks need to be performed as well, namely:
Check whether the job has not been cancelled in the meantime
Check whether another job is currently running with the same execution_key, and if so, delay this current job until the currently running one finishes
On job failure, the job needs to be queued in the retry queue, if the job is marked retryable. By default, jobs are not retried.
Link to this section Summary
Functions
Returns a specification to start this module under a supervisor
This is called when job needs to be cancelled it kills running job and runs the timeout task to correctly finish the job
This handle a hard crash
Invoked when the server is started. start_link/3
or start/3
will
block until it returns
This will make sure the worker task is killed when the worker get’s stopped
Link to this section Functions
Returns a specification to start this module under a supervisor.
See Supervisor
.
handle_call(:cancel_job, any(), Roger.Partition.Worker.State.t()) :: {:reply, :ok, Roger.Partition.Worker.State.t(), 0}
This is called when job needs to be cancelled it kills running job and runs the timeout task to correctly finish the job.
handle_info(:timeout, Roger.Partition.Worker.State.t()) :: {:noreply, Roger.Partition.Worker.State.t()} | {:stop, :normal, Roger.Partition.Worker.State.t()}
handle_info(:job_finished, Roger.Partition.Worker.State.t()) :: {:stop, :normal, Roger.Partition.Worker.State.t()}
handle_info(:job_errored, Roger.Partition.Worker.State.t()) :: {:stop, :normal, Roger.Partition.Worker.State.t()}
handle_info(:handle_job_timeout, Roger.Partition.Worker.State.t()) :: {:stop, :normal, Roger.Partition.Worker.State.t()}
handle_info( {:DOWN, reference(), :process, pid(), String.t()}, Roger.Partition.Worker.State.t() ) :: {:stop, :normal, Roger.Partition.Worker.State.t()}
This handle a hard crash
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 {: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
.
This will make sure the worker task is killed when the worker get’s stopped