Skip to content

Commit 6c85ef3

Browse files
committed
Add docs for #109
1 parent ffa8cc8 commit 6c85ef3

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

docs/en/index.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,10 @@ Usage
8787
Defining Jobs
8888
-------------
8989

90-
Create a Job class::
90+
Workloads are defined as 'jobs'. Job classes can recieve dependencies from your
91+
application's dependency injection container in their constructor just like
92+
Controllers or Commands. Jobs are responsible for processing queue messages.
93+
A simple job that logs received messages would look like::
9194

9295
<?php
9396
// src/Job/ExampleJob.php
@@ -144,7 +147,7 @@ The job **may** also return a null value, which is interpreted as
144147
``Processor::ACK``. Failure to respond with a valid type will result in an
145148
interpreted message failure and requeue of the message.
146149

147-
Properties:
150+
Job Properties:
148151

149152
- ``maxAttempts``: The maximum number of times the job may be requeued as a result
150153
of an exception or by explicitly returning ``Processor::REQUEUE``. If

0 commit comments

Comments
 (0)