Inheritance diagram for ConfigInterface:

Public Member Functions
	getServices ()

	getTopicName ($routeUrl, $httpMethod)

Data Fields
const	CACHE_ID = 'webapi_async_config'

const	TOPIC_PREFIX = 'async.'

const	DEFAULT_CONSUMER_INSTANCE = MassConsumer::class

const	DEFAULT_CONSUMER_CONNECTION = 'amqp'

const	DEFAULT_CONSUMER_MAX_MESSAGE = null

const	SERVICE_PARAM_KEY_INTERFACE = 'interface'

const	SERVICE_PARAM_KEY_METHOD = 'method'

const	SERVICE_PARAM_KEY_TOPIC = 'topic'

const	DEFAULT_HANDLER_NAME = 'async'

const	SYSTEM_TOPIC_NAME = 'async.system.required.wrapper.topic'

const	SYSTEM_TOPIC_CONFIGURATION

Detailed Description

Class for accessing to Webapi_Async configuration.

@api

Definition at line 19 of file ConfigInterface.php.

Member Function Documentation

◆ getServices()

getServices ( )

#- Get array of generated topics name and related to this topic service class and methods

Returns: array

Implemented in Config.

◆ getTopicName()

getTopicName	(	$routeUrl,
		$httpMethod
	)

Get topic name from webapi_async_config services config array by route url and http method

Parameters

string	$routeUrl
string	$httpMethod	GET\|POST\|PUT\|DELETE

Returns: string

Exceptions

Implemented in Config.

Field Documentation

◆ CACHE_ID

const CACHE_ID = 'webapi_async_config'

#+ Constants for Webapi Asynchronous Config generation

Definition at line 24 of file ConfigInterface.php.

◆ DEFAULT_CONSUMER_CONNECTION

const DEFAULT_CONSUMER_CONNECTION = 'amqp'

Definition at line 27 of file ConfigInterface.php.

◆ DEFAULT_CONSUMER_INSTANCE

const DEFAULT_CONSUMER_INSTANCE = MassConsumer::class

Definition at line 26 of file ConfigInterface.php.

◆ DEFAULT_CONSUMER_MAX_MESSAGE

const DEFAULT_CONSUMER_MAX_MESSAGE = null

Definition at line 28 of file ConfigInterface.php.

◆ DEFAULT_HANDLER_NAME

const DEFAULT_HANDLER_NAME = 'async'

Definition at line 32 of file ConfigInterface.php.

◆ SERVICE_PARAM_KEY_INTERFACE

const SERVICE_PARAM_KEY_INTERFACE = 'interface'

Definition at line 29 of file ConfigInterface.php.

◆ SERVICE_PARAM_KEY_METHOD

const SERVICE_PARAM_KEY_METHOD = 'method'

Definition at line 30 of file ConfigInterface.php.

◆ SERVICE_PARAM_KEY_TOPIC

const SERVICE_PARAM_KEY_TOPIC = 'topic'

Definition at line 31 of file ConfigInterface.php.

◆ SYSTEM_TOPIC_CONFIGURATION

const SYSTEM_TOPIC_CONFIGURATION

Initial value:

=  [
        CommunicationConfig::TOPIC_NAME           => self::SYSTEM_TOPIC_NAME,
        CommunicationConfig::TOPIC_IS_SYNCHRONOUS => false,
        CommunicationConfig::TOPIC_REQUEST        => OperationInterface::class,
        CommunicationConfig::TOPIC_REQUEST_TYPE   => CommunicationConfig::TOPIC_REQUEST_TYPE_CLASS,
        CommunicationConfig::TOPIC_RESPONSE       => null,
        CommunicationConfig::TOPIC_HANDLERS       => [],
    ]

Definition at line 34 of file ConfigInterface.php.

◆ SYSTEM_TOPIC_NAME

const SYSTEM_TOPIC_NAME = 'async.system.required.wrapper.topic'

Definition at line 33 of file ConfigInterface.php.

◆ TOPIC_PREFIX

const TOPIC_PREFIX = 'async.'

Definition at line 25 of file ConfigInterface.php.

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

vendor/magento/module-asynchronous-operations/Model/ConfigInterface.php

Public Member Functions

Data Fields