0 follower

Final Class Yiisoft\Queue\Middleware\FailureHandling\Implementation\SendAgainMiddleware

All Classes | Methods | Constants
InheritanceYiisoft\Queue\Middleware\FailureHandling\Implementation\SendAgainMiddleware
ImplementsYiisoft\Queue\Middleware\FailureHandling\MiddlewareFailureInterface

Failure strategy which resends the given message to a queue.

Public Methods

Hide inherited methods

Method Description Defined By
__construct() Yiisoft\Queue\Middleware\FailureHandling\Implementation\SendAgainMiddleware
processFailure() Yiisoft\Queue\Middleware\FailureHandling\Implementation\SendAgainMiddleware

Constants

Hide inherited constants

Constant Value Description Defined By
META_KEY_RESEND 'failure-strategy-resend-attempts' Yiisoft\Queue\Middleware\FailureHandling\Implementation\SendAgainMiddleware

Method Details

Hide inherited methods

__construct() public method

public mixed __construct ( string $id, integer $maxAttempts, Yiisoft\Queue\QueueInterface|null $targetQueue = null )
$id string

A unique id to differentiate two and more instances of this class
$maxAttempts integer

Maximum attempts count for this strategy with the given $id before it will give up
$targetQueue Yiisoft\Queue\QueueInterface|null

Messages will be sent to this queue if set. They will be resent to an original queue otherwise.

 

                public function __construct(
    private readonly string $id,
    private readonly int $maxAttempts,
    private readonly ?QueueInterface $targetQueue = null,
) {
    if ($maxAttempts < 1) {
        throw new InvalidArgumentException("maxAttempts parameter must be a positive integer, $this->maxAttempts given.");
    }
}
processFailure() public method

public Yiisoft\Queue\Middleware\FailureHandling\FailureHandlingRequest processFailure ( Yiisoft\Queue\Middleware\FailureHandling\FailureHandlingRequest $request, Yiisoft\Queue\Middleware\FailureHandling\MessageFailureHandlerInterface $handler )
$request Yiisoft\Queue\Middleware\FailureHandling\FailureHandlingRequest
$handler Yiisoft\Queue\Middleware\FailureHandling\MessageFailureHandlerInterface 

                public function processFailure(
    FailureHandlingRequest $request,
    MessageFailureHandlerInterface $handler
): FailureHandlingRequest {
    $message = $request->getMessage();
    if ($this->suites($message)) {
        $envelope = new FailureEnvelope($message, $this->createMeta($message));
        $envelope = ($this->targetQueue ?? $request->getQueue())->push($envelope);
        return $request->withMessage($envelope)
            ->withQueue($this->targetQueue ?? $request->getQueue());
    }
    return $handler->handleFailure($request);
}