queue/src/Adapter/AdapterInterface.php at message-handler-resolver · yiisoft/queue

History

38 lines (31 loc) · 1.26 KB

Raw

<?php

declare(strict_types=1);

namespace Yiisoft\Queue\Adapter;

use Yiisoft\Queue\MessageStatus;

use Yiisoft\Queue\Message\MessageInterface;

interface AdapterInterface

{

/**

* Returns the first message from the queue if it exists (null otherwise).

* @param callable(MessageInterface): bool $handlerCallback The handler which will handle messages. Returns false if it cannot continue handling messages

public function runExisting(callable $handlerCallback): void;

/**

* Returns status code of a message with the given ID.

* Returns {@see MessageStatus::NOT_FOUND} when status tracking is not supported or there is no such id.

* @param int|string $id ID of a message.

public function status(string|int $id): MessageStatus;

/**

* Pushing a message to the queue. Adapter sets message ID if available.

public function push(MessageInterface $message): MessageInterface;

/**

* Listen to the queue and pass messages to the given handler as they come.

* @param callable(MessageInterface): bool $handlerCallback The handler which will handle messages. Returns false if it cannot continue handling messages.

public function subscribe(callable $handlerCallback): void;

}

Navigation Menu

Uh oh!

Uh oh!

Uh oh!

Uh oh!

FilesExpand file tree

AdapterInterface.php

Latest commit

History

AdapterInterface.php

File metadata and controls