exq v0.13.2 Exq.Worker.Server
Worker process is responsible for the parsing and execution of a Job. It then broadcasts results to Stats / Manager.
Currently uses the terminate
callback to track job success/failure .
Initialization:
job_serialized
- Full JSON payload of the Job.manager
- Manager process pid.queue
- The queue the job came from.:work_table
- In process work ets table (TODO: Remove).stats
- Stats process pid.namespace
- Redis namespacehost
- Host name
Expects :work message after initialization to kickoff work.
Link to this section Summary
Functions
Returns a specification to start this module under a supervisor
Worker done with normal termination message
Invoked when the server is started. start_link/3
or start/3
will
block until it returns
Kickoff work associated with worker
Link to this section Functions
child_spec(arg)
Returns a specification to start this module under a supervisor.
See Supervisor
.
dispatch_work(worker_module, job, metadata)
handle_cast(msg, state)
Worker done with normal termination message
init(arg)
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
.
start_link(job_serialized, manager, queue, work_table, stats, namespace, host, redis, middleware, metadata)
work(pid)
Kickoff work associated with worker.