IMessageQueueFactory#

Fully qualified name: carb::eventdispatcher::IMessageQueueFactory

Defined in carb/eventdispatcher/IMessageQueue.h

struct IMessageQueueFactory#

The interface that functions as a message queue factory.

Public Functions

omni::expected<std::pair<IMessageQueuePtr, bool>, omni::core::Result> createMessageQueue(

RStringKey name,

const MessageQueueParams &params,

)#

Creates a message queue with the given name and parameters, or returns an existing message queue with the given name.

Errors

Accessible via the omni::unexpected return value.

• omni::core::kResultOutOfMemory - A new message queue could not be created.

• omni::core::kResultInvalidArgument - The sizeOf field of params is invalid.

Parameters:

• name – The unique name of the message queue. If the name already exists, the message queue will not be created but the previously-created message queue will be returned (params will be ignored). Since names must be unique, a scheme such as reverse-DNS is recommended.

• params – The parameters to use when creating the message queue. These are ignored if a message queue already exists with name.

Return values:

• std::pair<IMessageQueuePtr, bool> – A successful return produces a std::pair with first being a non-empty IMessageQueuePtr object, and second as a bool that is true if the message queue was newly created based on params, or false if the message queue previously existed.

• omni::core::Result – An error return produces a omni::unexpected containing an error code corresponding to the above list.

IMessageQueuePtr getMessageQueue(RStringKey name)#

Retrieves a message queue with the given name.

If there is no message queue with the given name, an empty IMessageQueuePtr is returned.

Parameters:

name – The unique name of the message queue, previously passed to createMessageQueue().

Returns:

A IMessageQueuePtr containing the located message queue, or an empty object if no queue exists with the given name.

Public Static Functions

static inline constexpr carb::InterfaceDesc getInterfaceDesc(

) noexcept#

Returns information about this interface.

Auto-generated by CARB_PLUGIN_INTERFACE() or CARB_PLUGIN_INTERFACE_EX.

Returns:

The carb::InterfaceDesc struct with information about this interface.

static inline constexpr carb::InterfaceDesc getLatestInterfaceDesc(

) noexcept#

Returns information about the latest version of this interface.

Auto-generated by CARB_PLUGIN_INTERFACE() or CARB_PLUGIN_INTERFACE_EX.

Returns:

The carb::InterfaceDesc struct with information about the latest version of this interface.