Interface Yiisoft\Queue\Provider\QueueConsumerProviderInterface

All Classes | Methods

Implemented by	Yiisoft\Queue\Debug\QueueConsumerProviderProxy, Yiisoft\Queue\Provider\CompositeQueueProvider, Yiisoft\Queue\Provider\PredefinedQueueProvider, Yiisoft\Queue\Provider\QueueFactoryProvider

Finds consumer capabilities by logical queue name.

Public Methods

Method	Description	Defined By
getConsumer()		Yiisoft\Queue\Provider\QueueConsumerProviderInterface
getConsumerQueueNames()		Yiisoft\Queue\Provider\QueueConsumerProviderInterface
hasConsumer()	Whether this queue name has a configured consumer role.	Yiisoft\Queue\Provider\QueueConsumerProviderInterface

getConsumer() public abstract method

public abstract Yiisoft\Queue\QueueConsumerInterface getConsumer ( string\|\BackedEnum $queueName )
$queueName	string\|\BackedEnum
throws	\Yiisoft\Queue\Provider\InvalidQueueConfigException\Yiisoft\Queue\Provider\QueueNotFoundException\Yiisoft\Queue\Provider\QueueProviderException

                public function getConsumer(string|BackedEnum $queueName): QueueConsumerInterface;

getConsumerQueueNames() public abstract method

public abstract list getConsumerQueueNames ( )
return	list	Queue names which have a configured consumer role.

                public function getConsumerQueueNames(): array;

hasConsumer() public abstract method

Whether this queue name has a configured consumer role.

public abstract boolean hasConsumer ( string\|\BackedEnum $queueName )
$queueName	string\|\BackedEnum

                public function hasConsumer(string|BackedEnum $queueName): bool;