Inheritance diagram for Config:

Public Member Functions
	__construct (Config\Data $queueConfigData)

	getExchangeByTopic ($topicName)

	getQueuesByTopic ($topic)

	getConnectionByTopic ($topic)

	getConnectionByConsumer ($consumer)

	getMessageSchemaType ($topic)

	getConsumerNames ()

	getConsumer ($name)

	getBinds ()

	getPublishers ()

	getConsumers ()

	getTopic ($name)

	getPublisher ($name)

	getResponseQueueName ($topicName)

Protected Member Functions
	getPublisherConfigByTopic ($topicName)

Protected Attributes
	$queueConfigData

Additional Inherited Members
Data Fields inherited from ConfigInterface
const	PUBLISHERS = 'publishers'

const	PUBLISHER_NAME = 'name'

const	PUBLISHER_CONNECTION = 'connection'

const	PUBLISHER_EXCHANGE = 'exchange'

const	TOPICS = 'topics'

const	TOPIC_NAME = 'name'

const	TOPIC_PUBLISHER = 'publisher'

const	TOPIC_SCHEMA = 'schema'

const	TOPIC_RESPONSE_SCHEMA = 'response_schema'

const	TOPIC_SCHEMA_TYPE = 'schema_type'

const	TOPIC_SCHEMA_VALUE = 'schema_value'

const	TOPIC_SCHEMA_TYPE_OBJECT = 'object'

const	TOPIC_SCHEMA_TYPE_METHOD = 'method_arguments'

const	SCHEMA_METHOD_PARAM_NAME = 'param_name'

const	SCHEMA_METHOD_PARAM_POSITION = 'param_position'

const	SCHEMA_METHOD_PARAM_TYPE = 'param_type'

const	SCHEMA_METHOD_PARAM_IS_REQUIRED = 'is_required'

const	CONSUMERS = 'consumers'

const	CONSUMER_NAME = 'name'

const	CONSUMER_QUEUE = 'queue'

const	CONSUMER_CONNECTION = 'connection'

const	CONSUMER_INSTANCE_TYPE = 'instance_type'

const	CONSUMER_CLASS = 'type'

const	CONSUMER_METHOD = 'method'

const	CONSUMER_MAX_MESSAGES = 'max_messages'

const	CONSUMER_HANDLERS = 'handlers'

const	CONSUMER_HANDLER_TYPE = 'type'

const	CONSUMER_HANDLER_METHOD = 'method'

const	CONSUMER_TYPE = 'consumer_type'

const	CONSUMER_TYPE_SYNC = 'sync'

const	CONSUMER_TYPE_ASYNC = 'async'

const	RESPONSE_QUEUE_PREFIX = 'responseQueue.'

const	BINDS = 'binds'

const	BIND_QUEUE = 'queue'

const	BIND_EXCHANGE = 'exchange'

const	BIND_TOPIC = 'topic'

const	BROKER_TOPIC = 'topic'

const	BROKER_TYPE = 'type'

const	BROKER_EXCHANGE = 'exchange'

const	BROKER_CONSUMERS = 'consumers'

const	BROKER_CONSUMER_NAME = 'name'

const	BROKER_CONSUMER_QUEUE = 'queue'

const	BROKER_CONSUMER_INSTANCE_TYPE = 'instance_type'

const	BROKER_CONSUMER_MAX_MESSAGES = 'max_messages'

const	BROKERS = 'brokers'

const	EXCHANGE_TOPIC_TO_QUEUES_MAP = 'exchange_topic_to_queues_map'

Detailed Description

Queue configuration.

Deprecated:: 100.2.0

Definition at line 17 of file Config.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( Config\Data $queueConfigData )

Parameters

Config\Data $queueConfigData

Definition at line 27 of file Config.php.

     {
         $this->queueConfigData = $queueConfigData;
     }

Member Function Documentation

◆ getBinds()

getBinds ( )

{Get queue binds

Returns: array

See also: \Magento\Framework\MessageQueue\Topology\ConfigInterface::getExchanges

}

Implements ConfigInterface.

Definition at line 132 of file Config.php.

     {
         return $this->queueConfigData->get(ConfigInterface::BINDS, []);
     }

◆ getConnectionByConsumer()

getConnectionByConsumer ( $consumer )

{

Parameters

string $consumer

Returns: string

Exceptions

LocalizedException

See also: \Magento\Framework\MessageQueue\Consumer\ConfigInterface::getConsumer

}

Implements ConfigInterface.

Definition at line 87 of file Config.php.

     {
         $connection = $this->queueConfigData->get(
             ConfigInterface::CONSUMERS . '/'. $consumer . '/'. ConfigInterface::CONSUMER_CONNECTION
         );
         if (!$connection) {
             throw new LocalizedException(
                 new Phrase('Consumer "%consumer" has not connection.', ['consumer' => $consumer])
             );
         }
         return $connection;
     }

◆ getConnectionByTopic()

getConnectionByTopic ( $topic )

{

Parameters

string $topic

Returns: string

Exceptions

LocalizedException

See also: \Magento\Framework\MessageQueue\Publisher\ConfigInterface::getPublisher

}

Implements ConfigInterface.

Definition at line 72 of file Config.php.

     {
         try {
             $publisherConfig = $this->getPublisherConfigByTopic($topic);
         } catch (\Magento\Framework\Exception\LocalizedException $e) {
             return null;
         }
         return isset($publisherConfig[ConfigInterface::PUBLISHER_CONNECTION])
             ? $publisherConfig[ConfigInterface::PUBLISHER_CONNECTION]
             : null;
     }

◆ getConsumer()

getConsumer ( $name )

{Get consumer configuration

Parameters

string $name

Returns: array|null

See also: \Magento\Framework\MessageQueue\Consumer\ConfigInterface::getConsumer

}

Implements ConfigInterface.

Definition at line 123 of file Config.php.

     {
 
         return $this->queueConfigData->get(ConfigInterface::CONSUMERS . '/' . $name);
     }

◆ getConsumerNames()

getConsumerNames ( )

{Get all consumer names

Returns: string[]

See also: \Magento\Framework\MessageQueue\Consumer\ConfigInterface::getConsumers

}

Implements ConfigInterface.

Definition at line 114 of file Config.php.

     {
         $queueConfig = $this->queueConfigData->get(ConfigInterface::CONSUMERS, []);
         return array_keys($queueConfig);
     }

◆ getConsumers()

getConsumers ( )

{Get consumers

Returns: array

See also: \Magento\Framework\MessageQueue\Consumer\ConfigInterface::getConsumers

}

Implements ConfigInterface.

Definition at line 148 of file Config.php.

     {
         return $this->queueConfigData->get(ConfigInterface::CONSUMERS, []);
     }

◆ getExchangeByTopic()

getExchangeByTopic ( $topicName )

{Identify configured exchange for the provided topic.

Parameters

string $topicName

Returns: string

Exceptions

LocalizedException

See also: \Magento\Framework\MessageQueue\Publisher\ConfigInterface::getPublisher

}

Implements ConfigInterface.

Definition at line 35 of file Config.php.

     {
         $publisherConfig = $this->getPublisherConfigByTopic($topicName);
         return isset($publisherConfig[ConfigInterface::PUBLISHER_EXCHANGE])
             ? $publisherConfig[ConfigInterface::PUBLISHER_EXCHANGE]
             : null;
     }

◆ getMessageSchemaType()

getMessageSchemaType ( $topic )

{Identify which option is used to define message schema: data interface or service method params

Parameters

string $topic

Returns: string

See also: \Magento\Framework\Communication\ConfigInterface::getTopic

}

Implements ConfigInterface.

Definition at line 103 of file Config.php.

     {
         return $this->queueConfigData->get(
             ConfigInterface::TOPICS . '/' .
             $topic . '/' . ConfigInterface::TOPIC_SCHEMA . '/' . ConfigInterface::TOPIC_SCHEMA_TYPE
         );
     }

◆ getPublisher()

getPublisher ( $name )

{Get published config

Parameters

string $name

Returns: array

See also: \Magento\Framework\MessageQueue\Publisher\ConfigInterface::getPublisher

}

Implements ConfigInterface.

Definition at line 164 of file Config.php.

     {
         return $this->queueConfigData->get(ConfigInterface::PUBLISHERS . '/' . $name);
     }

◆ getPublisherConfigByTopic()

getPublisherConfigByTopic ( $topicName )

protected

Get publisher config by topic

Parameters

string $topicName

Returns: array|mixed|null

Exceptions

LocalizedException

Definition at line 184 of file Config.php.

     {
         $publisherName = $this->queueConfigData->get(
             ConfigInterface::TOPICS . '/' . $topicName . '/' . ConfigInterface::TOPIC_PUBLISHER
         );
 
         if (!$publisherName) {
             throw new LocalizedException(
                 new Phrase('Message queue topic "%topic" is not configured.', ['topic' => $topicName])
             );
         }
 
         $publisherConfig = $this->queueConfigData->get(ConfigInterface::PUBLISHERS . '/' . $publisherName);
         if (!$publisherConfig) {
             throw new LocalizedException(
                 new Phrase(
                     'Message queue publisher "%publisher" is not configured.',
                     ['publisher' => $publisherName]
                 )
             );
         }
         return $publisherConfig;
     }

◆ getPublishers()

getPublishers ( )

{Get publishers

Returns: array

See also: \Magento\Framework\MessageQueue\Publisher\ConfigInterface::getPublishers

}

Implements ConfigInterface.

Definition at line 140 of file Config.php.

     {
         return $this->queueConfigData->get(ConfigInterface::PUBLISHERS, []);
     }

◆ getQueuesByTopic()

getQueuesByTopic ( $topic )

{Identify a list of all queue names corresponding to the specified topic (and implicitly exchange).

Parameters

string $topic

Returns: string[]

Exceptions

LocalizedException

See also: \Magento\Framework\MessageQueue\Topology\ConfigInterface::getQueues

}

Exchange should be taken into account here to avoid retrieving queues, related to another exchange, which is not currently associated with topic, but is configured in binds

Implements ConfigInterface.

Definition at line 46 of file Config.php.

     {
         $publisherConfig = $this->getPublisherConfigByTopic($topic);
         $exchange = isset($publisherConfig[ConfigInterface::PUBLISHER_NAME])
             ? $publisherConfig[ConfigInterface::PUBLISHER_NAME]
             : null;
         $bindKey = $exchange . '--' . $topic;
         $output = $this->queueConfigData->get(ConfigInterface::EXCHANGE_TOPIC_TO_QUEUES_MAP . '/' . $bindKey);
         if (!$output) {
             throw new LocalizedException(
                 new Phrase(
                     'No bindings configured for the "%topic" topic at "%exchange" exchange.',
                     ['topic' => $topic, 'exchange' => $exchange]
                 )
             );
         }
         return $output;
     }

◆ getResponseQueueName()

getResponseQueueName ( $topicName )

{Get queue name for response

Parameters

string $topicName

Returns: string

See also: \Magento\Framework\MessageQueue\Rpc\ResponseQueueNameBuilder::getQueueName

}

Implements ConfigInterface.

Definition at line 172 of file Config.php.

     {
         return ConfigInterface::RESPONSE_QUEUE_PREFIX . str_replace('-', '_', $topicName);
     }

◆ getTopic()

getTopic ( $name )

{Get topic config

Parameters

string $name

Returns: array

See also: \Magento\Framework\Communication\ConfigInterface::getTopic; \Magento\Framework\MessageQueue\Publisher\ConfigInterface::getPublisher

}

Implements ConfigInterface.

Definition at line 156 of file Config.php.

     {
         return $this->queueConfigData->get(ConfigInterface::TOPICS . '/' . $name);
     }

Field Documentation

◆ $queueConfigData

$queueConfigData

protected

Definition at line 22 of file Config.php.

The documentation for this class was generated from the following file:

vendor/magento/framework-message-queue/Config.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getBinds()

◆ getConnectionByConsumer()

◆ getConnectionByTopic()

◆ getConsumer()

◆ getConsumerNames()

◆ getConsumers()

◆ getExchangeByTopic()

◆ getMessageSchemaType()

◆ getPublisher()

◆ getPublisherConfigByTopic()

◆ getPublishers()

◆ getQueuesByTopic()

◆ getResponseQueueName()

◆ getTopic()

Field Documentation

◆ $queueConfigData