1Minion::Worker(3) User Contributed Perl Documentation Minion::Worker(3)
2
6 Minion::Worker - Minion worker
7
9 use Minion::Worker;
10 my $worker = Minion::Worker->new(minion => $minion);
12
14 Minion::Worker performs jobs for Minion.
15
17 The Minion::Worker process can be controlled at runtime with the
18 following signals.
19 INT, TERM
21 Stop gracefully after finishing the current jobs.
22 QUIT
24 Stop immediately without finishing the current jobs.
25
27 The job processes spawned by the Minion::Worker process can be
28 controlled at runtime with the following signals.
29 INT
31 This signal starts out with the operating system default and allows for
32 jobs to install a custom signal handler to stop gracefully.
33 USR1, USR2
35 These signals start out being ignored and allow for jobs to install
36 custom signal handlers.
37
39 Minion::Worker inherits all events from Mojo::EventEmitter and can emit
40 the following new ones.
41 busy
43 $worker->on(busy => sub {
44 my $worker = shift;
45 ...
46 });
47 Emitted in the worker process when it is performing the maximum number
49 of jobs in parallel.
50 $worker->on(busy => sub {
52 my $worker = shift;
53 my $max = $worker->status->{jobs};
54 say "Performing $max jobs.";
55 });
56 dequeue
58 $worker->on(dequeue => sub {
59 my ($worker, $job) = @_;
60 ...
61 });
62 Emitted in the worker process after a job has been dequeued.
64 $worker->on(dequeue => sub {
66 my ($worker, $job) = @_;
67 my $id = $job->id;
68 say "Job $id has been dequeued.";
69 });
70 wait
72 $worker->on(wait => sub {
73 my $worker = shift;
74 ...
75 });
76 Emitted in the worker process before it tries to dequeue a job.
78 $worker->on(wait => sub {
80 my $worker = shift;
81 my $max = $worker->status->{dequeue_timeout};
82 say "Waiting up to $max seconds for a new job.";
83 });
84
86 Minion::Worker implements the following attributes.
87 commands
89 my $commands = $worker->commands;
90 $worker = $worker->commands({jobs => sub {...}});
91 Registered worker remote control commands.
93 id
95 my $id = $worker->id;
96 $worker = $worker->id($id);
97 Worker id.
99 minion
101 my $minion = $worker->minion;
102 $worker = $worker->minion(Minion->new);
103 Minion object this worker belongs to.
105 status
107 my $status = $worker->status;
108 $worker = $worker->status({queues => ['default', 'important']);
109 Status information to configure workers started with "run" and to share
111 every time "register" is called.
112
114 Minion::Worker inherits all methods from Mojo::EventEmitter and
115 implements the following new ones.
116 add_command
118 $worker = $worker->add_command(jobs => sub {...});
119 Register a worker remote control command.
121 $worker->add_command(foo => sub {
123 my ($worker, @args) = @_;
124 ...
125 });
126 dequeue
128 my $job = $worker->dequeue(0.5);
129 my $job = $worker->dequeue(0.5 => {queues => ['important']});
130 Wait a given amount of time in seconds for a job, dequeue Minion::Job
132 object and transition from "inactive" to "active" state, or return
133 "undef" if queues were empty.
134 These options are currently available:
136 id
138 id => '10023'
139 Dequeue a specific job.
141 queues
143 queues => ['important']
144 One or more queues to dequeue jobs from, defaults to "default".
146 info
148 my $info = $worker->info;
149 Get worker information.
151 # Check worker host
153 my $host = $worker->info->{host};
154 These fields are currently available:
156 host
158 host => 'localhost'
159 Worker host.
161 jobs
163 jobs => ['10023', '10024', '10025', '10029']
164 Ids of jobs the worker is currently processing.
166 notified
168 notified => 784111777
169 Epoch time worker sent the last heartbeat.
171 pid
173 pid => 12345
174 Process id of worker.
176 started
178 started => 784111777
179 Epoch time worker was started.
181 status
183 status => {queues => ['default', 'important']}
184 Hash reference with whatever status information the worker would like
186 to share.
187 new
189 my $worker = Minion::Worker->new;
190 my $worker = Minion::Worker->new(status => {foo => 'bar'});
191 my $worker = Minion::Worker->new({status => {foo => 'bar'}});
192 Construct a new Minion::Worker object and subscribe to "busy" event
194 with default handler that sleeps for one second.
195 process_commands
197 $worker = $worker->process_commands;
198 Process worker remote control commands.
200 register
202 $worker = $worker->register;
203 Register worker or send heartbeat to show that this worker is still
205 alive.
206 run
208 $worker->run;
209 Run worker and wait for "WORKER SIGNALS".
211 These "status" options are currently available:
213 command_interval
215 command_interval => 20
216 Worker remote control command interval, defaults to 10.
218 dequeue_timeout
220 dequeue_timeout => 5
221 Maximum amount time in seconds to wait for a job, defaults to 5.
223 heartbeat_interval
225 heartbeat_interval => 60
226 Heartbeat interval, defaults to 300.
228 jobs
230 jobs => 12
231 Maximum number of jobs to perform parallel in forked worker
233 processes, defaults to 4.
234 queues
236 queues => ['test']
237 One or more queues to get jobs from, defaults to "default".
239 repair_interval
241 repair_interval => 3600
242 Repair interval, up to half of this value can be subtracted randomly
244 to make sure not all workers repair at the same time, defaults to
245 21600 (6 hours).
246 These remote control "commands" are currently available:
248 jobs
250 $minion->broadcast('jobs', [10]);
251 $minion->broadcast('jobs', [10], [$worker_id]);
252 Instruct one or more workers to change the number of jobs to perform
254 concurrently. Setting this value to 0 will effectively pause the
255 worker. That means all current jobs will be finished, but no new ones
256 accepted, until the number is increased again.
257 kill
259 $minion->broadcast('kill', ['INT', 10025]);
260 $minion->broadcast('kill', ['INT', 10025], [$worker_id]);
261 Instruct one or more workers to send a signal to a job that is
263 currently being performed. This command will be ignored by workers
264 that do not have a job matching the id. That means it is safe to
265 broadcast this command to all workers.
266 stop
268 $minion->broadcast('stop', [10025]);
269 $minion->broadcast('stop', [10025], [$worker_id]);
270 Instruct one or more workers to stop a job that is currently being
272 performed immediately. This command will be ignored by workers that
273 do not have a job matching the id. That means it is safe to broadcast
274 this command to all workers.
275 unregister
277 $worker = $worker->unregister;
278 Unregister worker.
280
282 Minion, Mojolicious::Guides, <https://mojolicious.org>.
283perl v5.30.0 2019-09-01 Minion::Worker(3)