类 LimitAttemptsExtension
命名空间: Cake\Queue\Consumption
常量
-
字符串ATTEMPTS_PROPERTY ¶'attempts'用于设置消息尝试次数的属性键。
属性摘要
-
$_eventClass protected
字符串新事件对象的默认类名。
-
$_eventManager protected
Cake\Event\EventManagerInterface|null此对象用于分派内部事件的 Cake\Event\EventManager 实例。
-
$maxAttempts protected
int|null作业可以尝试的最大次数。在作业中定义的 $maxAttempts 将覆盖此值。
方法摘要
-
__construct() public
-
dispatchEvent() public
用于创建和分派事件的包装器。
-
getEventManager() public
返回此对象的 Cake\Event\EventManager 管理器实例。
-
onResult() public
在消息由处理器处理或在 onMessageReceived 扩展方法中设置结果时执行。在消息状态发送到代理之前。结果可以在此时更改。
-
setEventManager() public
返回此对象的 Cake\Event\EventManagerInterface 实例。
方法详情
__construct() ¶ public
__construct(int|null $maxAttempts = null): void参数
-
int|null$maxAttempts optional 作业可以尝试的最大次数。
返回值
voiddispatchEvent() ¶ public
dispatchEvent(string $name, array $data = [], TSubject|null $subject = null): Cake\Event\EventInterface<TSubject>用于创建和分派事件的包装器。
返回已分派的事件。
参数
-
string$name 事件的名称。
-
array$data optional 您希望通过此事件传输的任何值，都可以由监听器读取。
-
TSubject|null$subject optional 此事件适用的对象（默认为 $this）。
返回值
Cake\Event\EventInterface<TSubject>getEventManager() ¶ public
getEventManager(): Cake\Event\EventManagerInterface返回此对象的 Cake\Event\EventManager 管理器实例。
您可以使用此实例将任何新的监听器或回调注册到对象事件，或者创建您自己的事件并随意触发它们。
返回值
Cake\Event\EventManagerInterfaceonResult() ¶ public
onResult(MessageResult $context): void在消息由处理器处理或在 onMessageReceived 扩展方法中设置结果时执行。在消息状态发送到代理之前。结果可以在此时更改。
参数
-
MessageResult$context 消息处理后的结果。
返回值
voidsetEventManager() ¶ public
setEventManager(Cake\Event\EventManagerInterface $eventManager): $this返回此对象的 Cake\Event\EventManagerInterface 实例。
您可以使用此实例将任何新的监听器或回调注册到对象事件，或者创建您自己的事件并随意触发它们。
参数
-
Cake\Event\EventManagerInterface$eventManager 要设置的 eventManager
返回值
$this