Navigation
API > API/Runtime > API/Runtime/Messaging
Log category for message bus code Interface for messaging modules.
| Name | IMessagingModule |
| Type | class |
| Header File | /Engine/Source/Runtime/Messaging/Public/IMessagingModule.h |
| Include Path | #include "IMessagingModule.h" |
Syntax
class IMessagingModule : public IModuleInterface
Implements Interfaces
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IMessagingModule() |
Virtual destructor. | IMessagingModule.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FMessageBusWeakPtr | TWeakPtr< IMessageBus, ESPMode::ThreadSafe > | IMessagingModule.h | |
| FOnMessageBusStartupOrShutdown | TMulticastDelegate_OneParam< void, FMessageBusWeakPtr > | IMessagingModule.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedPtr< IMessageBridge, ESPMode::ThreadSafe > CreateBridge
(
const FMessageAddress& Address, |
Creates a new message bridge. | IMessagingModule.h | |
TSharedPtr< IMessageBus, ESPMode::ThreadSafe > CreateBus
(
const TSharedPtr< IAuthorizeMessageRecipients >& RecipientAuthorizer |
Creates a new message bus. | IMessagingModule.h | |
TSharedPtr< IMessageBus, ESPMode::ThreadSafe > CreateBus
(
FString InName, |
Creates a new message bus. | IMessagingModule.h | |
TArray< TSharedRef< IMessageBus, ESPMode::ThreadSafe > > GetAllBuses() |
Gets all message buses that were created by this module via the CreateBus method that are still valid. | IMessagingModule.h | |
TSharedPtr< IMessageBus, ESPMode::ThreadSafe > GetDefaultBus() |
Gets the default message bus if it has been initialized. | IMessagingModule.h | |
FOnMessageBusStartupOrShutdown & OnMessageBusShutdown() |
Event triggered when a message bus is shutdown. | IMessagingModule.h | |
FOnMessageBusStartupOrShutdown & OnMessageBusStartup() |
Event triggered when a message bus is started. | IMessagingModule.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static IMessagingModule & Get() |
Gets a reference to the messaging module instance. | IMessagingModule.h |