upd docs.

php-enqueue · Sep 11, 2017 · 7b3af54 · 7b3af54
1 parent 812a069
commit 7b3af54
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 30 deletions.
diff --git a/docs/bundle/cli_commands.md b/docs/bundle/cli_commands.md
@@ -20,22 +20,24 @@ Usage:
   enq:c
 
 Arguments:
-  client-queue-names                 Queues to consume messages from
+  client-queue-names                     Queues to consume messages from
 
 Options:
-      --message-limit=MESSAGE-LIMIT  Consume n messages and exit
-      --time-limit=TIME-LIMIT        Consume messages during this time
-      --memory-limit=MEMORY-LIMIT    Consume messages until process reaches this memory limit in MB
-      --setup-broker                 Creates queues, topics, exchanges, binding etc on broker side.
-  -h, --help                         Display this help message
-  -q, --quiet                        Do not output any message
-  -V, --version                      Display this application version
-      --ansi                         Force ANSI output
-      --no-ansi                      Disable ANSI output
-  -n, --no-interaction               Do not ask any interactive question
-  -e, --env=ENV                      The environment name [default: "dev"]
-      --no-debug                     Switches off debug mode
-  -v|vv|vvv, --verbose               Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
+      --message-limit=MESSAGE-LIMIT      Consume n messages and exit
+      --time-limit=TIME-LIMIT            Consume messages during this time
+      --memory-limit=MEMORY-LIMIT        Consume messages until process reaches this memory limit in MB
+      --setup-broker                     Creates queues, topics, exchanges, binding etc on broker side.
+      --idle-timeout=IDLE-TIMEOUT        The time in milliseconds queue consumer idle if no message has been received.
+      --receive-timeout=RECEIVE-TIMEOUT  The time in milliseconds queue consumer waits for a message.
+  -h, --help                             Display this help message
+  -q, --quiet                            Do not output any message
+  -V, --version                          Display this application version
+      --ansi                             Force ANSI output
+      --no-ansi                          Disable ANSI output
+  -n, --no-interaction                   Do not ask any interactive question
+  -e, --env=ENV                          The environment name [default: "test"]
+      --no-debug                         Switches off debug mode
+  -v|vv|vvv, --verbose                   Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
 
 Help:
   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:
 
 ```
 ./bin/console enqueue:transport:consume --help
-Usage:
+Usage:ng mqdev_gearmand_1 ... done
   enqueue:transport:consume [options] [--] <processor-service>
 
 Arguments:
-  processor-service                  A message processor service
+  processor-service                      A message processor service
 
 Options:
-      --message-limit=MESSAGE-LIMIT  Consume n messages and exit
-      --time-limit=TIME-LIMIT        Consume messages during this time
-      --memory-limit=MEMORY-LIMIT    Consume messages until process reaches this memory limit in MB
-      --queue[=QUEUE]                Queues to consume from (multiple values allowed)
-  -h, --help                         Display this help message
-  -q, --quiet                        Do not output any message
-  -V, --version                      Display this application version
-      --ansi                         Force ANSI output
-      --no-ansi                      Disable ANSI output
-  -n, --no-interaction               Do not ask any interactive question
-  -e, --env=ENV                      The environment name [default: "dev"]
-      --no-debug                     Switches off debug mode
-  -v|vv|vvv, --verbose               Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
+      --message-limit=MESSAGE-LIMIT      Consume n messages and exit
+      --time-limit=TIME-LIMIT            Consume messages during this time
+      --memory-limit=MEMORY-LIMIT        Consume messages until process reaches this memory limit in MB
+      --idle-timeout=IDLE-TIMEOUT        The time in milliseconds queue consumer idle if no message has been received.
+      --receive-timeout=RECEIVE-TIMEOUT  The time in milliseconds queue consumer waits for a message.
+      --queue[=QUEUE]                    Queues to consume from (multiple values allowed)
+  -h, --help                             Display this help message
+  -q, --quiet                            Do not output any message
+  -V, --version                          Display this application version
+      --ansi                             Force ANSI output
+      --no-ansi                          Disable ANSI output
+  -n, --no-interaction                   Do not ask any interactive question
+  -e, --env=ENV                          The environment name [default: "test"]
+      --no-debug                         Switches off debug mode
+  -v|vv|vvv, --verbose                   Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
 
 Help:
   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

diff --git a/docs/bundle/config_reference.md b/docs/bundle/config_reference.md
@@ -298,6 +298,13 @@ enqueue:
         router_processor:     enqueue.client.router_processor
         default_processor_queue: default
         redelivered_delay_time: 0
+    consumption:
+
+        # the time in milliseconds queue consumer waits if no message received
+        idle_timeout:         0
+
+        # the time in milliseconds queue consumer waits for a message (100 ms by default)
+        receive_timeout:      100
     job:                  false
     async_events:
         enabled:              false
@@ -306,6 +313,8 @@ enqueue:
         doctrine_clear_identity_map_extension: false
         signal_extension:     true
         reply_extension:      true
+
+
 ```
 
 [back to index](../index.md)
diff --git a/pkg/enqueue/Symfony/Consumption/QueueConsumerOptionsCommandTrait.php b/pkg/enqueue/Symfony/Consumption/QueueConsumerOptionsCommandTrait.php
@@ -14,7 +14,7 @@ trait QueueConsumerOptionsCommandTrait
     protected function configureQueueConsumerOptions()
     {
         $this
-            ->addOption('idle-timeout', null, InputOption::VALUE_REQUIRED, 'The time in milliseconds queue consumer waits if no message received.')
+            ->addOption('idle-timeout', null, InputOption::VALUE_REQUIRED, 'The time in milliseconds queue consumer idle if no message has been received.')
             ->addOption('receive-timeout', null, InputOption::VALUE_REQUIRED, 'The time in milliseconds queue consumer waits for a message.')
         ;
     }