Class LimitAttemptsExtension
Constants
-
stringATTEMPTS_PROPERTY ¶'attempts'The property key used to set the number of times a message was attempted.
Property Summary
-
$_eventClass protected
stringDefault class name for new event objects.
-
$_eventManager protected
Cake\Event\EventManagerInterface|nullInstance of the Cake\Event\EventManager this object is using to dispatch inner events.
-
$maxAttempts protected
int|nullThe maximum number of times a job may be attempted. $maxAttempts defined on a Job will override this value.
Method Summary
-
__construct() public
-
dispatchEvent() public
Wrapper for creating and dispatching events.
-
getEventManager() public
Returns the Cake\Event\EventManager manager instance for this object.
-
onResult() public
Executed when a message is processed by a processor or a result was set in onMessageReceived extension method. BEFORE the message status was sent to the broker The result could be changed at this point.
-
setEventManager() public
Returns the Cake\Event\EventManagerInterface instance for this object.
Method Detail
__construct() ¶ public
__construct(int|null $maxAttempts = null): voidParameters
-
int|null$maxAttempts optional The maximum number of times a job may be attempted.
Returns
voiddispatchEvent() ¶ public
dispatchEvent(string $name, array $data = [], TSubject|null $subject = null): Cake\Event\EventInterface<TSubject>Wrapper for creating and dispatching events.
Returns a dispatched event.
Parameters
-
string$name Name of the event.
-
array$data optional Any value you wish to be transported with this event to it can be read by listeners.
-
TSubject|null$subject optional The object that this event applies to ($this by default).
Returns
Cake\Event\EventInterface<TSubject>getEventManager() ¶ public
getEventManager(): Cake\Event\EventManagerInterfaceReturns the Cake\Event\EventManager manager instance for this object.
You can use this instance to register any new listeners or callbacks to the object events, or create your own events and trigger them at will.
Returns
Cake\Event\EventManagerInterfaceonResult() ¶ public
onResult(MessageResult $context): voidExecuted when a message is processed by a processor or a result was set in onMessageReceived extension method. BEFORE the message status was sent to the broker The result could be changed at this point.
Parameters
-
MessageResult$context The result of the message after it was processed.
Returns
voidsetEventManager() ¶ public
setEventManager(Cake\Event\EventManagerInterface $eventManager): $thisReturns the Cake\Event\EventManagerInterface instance for this object.
You can use this instance to register any new listeners or callbacks to the object events, or create your own events and trigger them at will.
Parameters
-
Cake\Event\EventManagerInterface$eventManager the eventManager to set
Returns
$thisProperty Detail
$_eventManager ¶ protected
Instance of the Cake\Event\EventManager this object is using to dispatch inner events.
Type
Cake\Event\EventManagerInterface|null$maxAttempts ¶ protected
The maximum number of times a job may be attempted. $maxAttempts defined on a Job will override this value.
Type
int|null