IMessagingModule

Interface for messaging modules.

Windows
MacOS
Linux

Inheritance Hierarchy

IModuleInterface

IMessagingModule

References

Module

Messaging

Header

/Engine/Source/Runtime/Messaging/Public/IMessagingModule.h

Include

#include "IMessagingModule.h"

Syntax

class IMessagingModule : public IModuleInterface

Remarks

Interface for messaging modules.

Destructors

Name Description

Public function Virtual

~IMessagingModule()

Virtual destructor.

Functions

Name Description

Public function

TSharedPtr< ...

 

CreateBridge

(
    const FMessageAddress& Address,
    const TSharedRef< IMessageBus, ESPM...,
    const TSharedRef< IMessageTransport...
)

Creates a new message bridge.

Public function

TSharedPtr< ...

 

CreateBus

(
    const TSharedPtr< IAuthorizeMessage...
)

Creates a new message bus.

Public function

TSharedPtr< ...

 

CreateBus

(
    FString InName,
    const TSharedPtr< IAuthorizeMessage...
)

Creates a new message bus.

Public function Static

IMessagingMo...

 

Get()

Gets a reference to the messaging module instance.

Public function Const

TArray< TSha...

 

GetAllBuses()

Gets all message buses that were created by this module via the CreateBus method that are still valid.

Public function Const

TSharedPtr< ...

 

GetDefaultBus()

Gets the default message bus if it has been initialized.

Public function

FOnMessageBu...

 

OnMessageBusShutdown()

Event triggered when a message bus is shutdown.

Public function

FOnMessageBu...

 

OnMessageBusStartup()

Event triggered when a message bus is started.

Typedefs

Name

Description

FOnMessageBusStartupOrShutdown

Delegate type, helper macro cannot be used due to comma in expansion can't be avoided with extra parenthesis.

See Also

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss