Skip to content

Commit ee6384b

Browse files
committed
upd docs.
1 parent 4cbe640 commit ee6384b

File tree

3 files changed

+43
-30
lines changed

3 files changed

+43
-30
lines changed

docs/bundle/cli_commands.md

Lines changed: 33 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -20,22 +20,24 @@ Usage:
2020
enq:c
2121
2222
Arguments:
23-
client-queue-names Queues to consume messages from
23+
client-queue-names Queues to consume messages from
2424
2525
Options:
26-
--message-limit=MESSAGE-LIMIT Consume n messages and exit
27-
--time-limit=TIME-LIMIT Consume messages during this time
28-
--memory-limit=MEMORY-LIMIT Consume messages until process reaches this memory limit in MB
29-
--setup-broker Creates queues, topics, exchanges, binding etc on broker side.
30-
-h, --help Display this help message
31-
-q, --quiet Do not output any message
32-
-V, --version Display this application version
33-
--ansi Force ANSI output
34-
--no-ansi Disable ANSI output
35-
-n, --no-interaction Do not ask any interactive question
36-
-e, --env=ENV The environment name [default: "dev"]
37-
--no-debug Switches off debug mode
38-
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
26+
--message-limit=MESSAGE-LIMIT Consume n messages and exit
27+
--time-limit=TIME-LIMIT Consume messages during this time
28+
--memory-limit=MEMORY-LIMIT Consume messages until process reaches this memory limit in MB
29+
--setup-broker Creates queues, topics, exchanges, binding etc on broker side.
30+
--idle-timeout=IDLE-TIMEOUT The time in milliseconds queue consumer idle if no message has been received.
31+
--receive-timeout=RECEIVE-TIMEOUT The time in milliseconds queue consumer waits for a message.
32+
-h, --help Display this help message
33+
-q, --quiet Do not output any message
34+
-V, --version Display this application version
35+
--ansi Force ANSI output
36+
--no-ansi Disable ANSI output
37+
-n, --no-interaction Do not ask any interactive question
38+
-e, --env=ENV The environment name [default: "test"]
39+
--no-debug Switches off debug mode
40+
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
3941
4042
Help:
4143
A client's worker that processes messages. By default it connects to default queue. It select an appropriate message processor based on a message headers
@@ -143,26 +145,28 @@ Help:
143145

144146
```
145147
./bin/console enqueue:transport:consume --help
146-
Usage:
148+
Usage:ng mqdev_gearmand_1 ... done
147149
enqueue:transport:consume [options] [--] <processor-service>
148150
149151
Arguments:
150-
processor-service A message processor service
152+
processor-service A message processor service
151153
152154
Options:
153-
--message-limit=MESSAGE-LIMIT Consume n messages and exit
154-
--time-limit=TIME-LIMIT Consume messages during this time
155-
--memory-limit=MEMORY-LIMIT Consume messages until process reaches this memory limit in MB
156-
--queue[=QUEUE] Queues to consume from (multiple values allowed)
157-
-h, --help Display this help message
158-
-q, --quiet Do not output any message
159-
-V, --version Display this application version
160-
--ansi Force ANSI output
161-
--no-ansi Disable ANSI output
162-
-n, --no-interaction Do not ask any interactive question
163-
-e, --env=ENV The environment name [default: "dev"]
164-
--no-debug Switches off debug mode
165-
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
155+
--message-limit=MESSAGE-LIMIT Consume n messages and exit
156+
--time-limit=TIME-LIMIT Consume messages during this time
157+
--memory-limit=MEMORY-LIMIT Consume messages until process reaches this memory limit in MB
158+
--idle-timeout=IDLE-TIMEOUT The time in milliseconds queue consumer idle if no message has been received.
159+
--receive-timeout=RECEIVE-TIMEOUT The time in milliseconds queue consumer waits for a message.
160+
--queue[=QUEUE] Queues to consume from (multiple values allowed)
161+
-h, --help Display this help message
162+
-q, --quiet Do not output any message
163+
-V, --version Display this application version
164+
--ansi Force ANSI output
165+
--no-ansi Disable ANSI output
166+
-n, --no-interaction Do not ask any interactive question
167+
-e, --env=ENV The environment name [default: "test"]
168+
--no-debug Switches off debug mode
169+
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
166170
167171
Help:
168172
A worker that consumes message from a broker. To use this broker you have to explicitly set a queue to consume from and a message processor service

docs/bundle/config_reference.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -298,6 +298,13 @@ enqueue:
298298
router_processor: enqueue.client.router_processor
299299
default_processor_queue: default
300300
redelivered_delay_time: 0
301+
consumption:
302+
303+
# the time in milliseconds queue consumer waits if no message received
304+
idle_timeout: 0
305+
306+
# the time in milliseconds queue consumer waits for a message (100 ms by default)
307+
receive_timeout: 100
301308
job: false
302309
async_events:
303310
enabled: false
@@ -306,6 +313,8 @@ enqueue:
306313
doctrine_clear_identity_map_extension: false
307314
signal_extension: true
308315
reply_extension: true
316+
317+
309318
```
310319

311320
[back to index](../index.md)

pkg/enqueue/Symfony/Consumption/QueueConsumerOptionsCommandTrait.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ trait QueueConsumerOptionsCommandTrait
1414
protected function configureQueueConsumerOptions()
1515
{
1616
$this
17-
->addOption('idle-timeout', null, InputOption::VALUE_REQUIRED, 'The time in milliseconds queue consumer waits if no message received.')
17+
->addOption('idle-timeout', null, InputOption::VALUE_REQUIRED, 'The time in milliseconds queue consumer idle if no message has been received.')
1818
->addOption('receive-timeout', null, InputOption::VALUE_REQUIRED, 'The time in milliseconds queue consumer waits for a message.')
1919
;
2020
}

0 commit comments

Comments
 (0)