Kaynağa Gözat

Updated documentation of GearmanExecuteWorkEvent

orolin 11 yıl önce
ebeveyn
işleme
9c8bec7447
1 değiştirilmiş dosya ile 19 ekleme ve 1 silme
  1. 19 1
      Resources/docs/kernel_events.rst

+ 19 - 1
Resources/docs/kernel_events.rst

@@ -113,4 +113,22 @@ For more information about this GearmanEvent, read [GearmanClient::setWorkloadCa
         my_event_listener:
             class: AcmeBundle\EventListener\MyEventListener
             tags:
-              - { name: kernel.event_listener, event: gearman.client.callback.workload, method: onWorkload }
+              - { name: kernel.event_listener, event: gearman.client.callback.workload, method: onWorkload }
+
+Execute Work Event
+~~~~~~~~~~~~~~~~~~
+
+This event receives as parameter an instanceof `Mmoreram\GearmanBundle\Event\GearmanExecuteWorkEvent` with four methods:
+`$event->getJobs()` returns the configuration of the jobs,
+`$event->getIterationsRemaining()` returns the remaining iterations for these jobs,
+`$event->getReturnCode()` returns the return code of the last executed job.
+
+This event is dispatched after a job has been completed.  After this event is completed, the worker continues with its iterations.
+
+.. code-block:: yml
+
+    services:
+        my_event_listener:
+            class: AcmeBundle\EventListener\MyEventListener
+            tags:
+              - { name: kernel.event_listener, event: gearman.execute.work, method: onWork }