IMessagingModule Class Reference

#include <IMessagingModule.h>

Inheritance diagram for IMessagingModule:

Public Member Functions
	DECLARE_MULTICAST_DELEGATE_OneParam (FOnMessageBusStartupOrShutdown, FMessageBusWeakPtr)
virtual FOnMessageBusStartupOrShutdown &	OnMessageBusStartup ()=0
virtual FOnMessageBusStartupOrShutdown &	OnMessageBusShutdown ()=0
virtual TSharedPtr< IMessageBridge, ESPMode::ThreadSafe >	CreateBridge (const FMessageAddress &Address, const TSharedRef< IMessageBus, ESPMode::ThreadSafe > &Bus, const TSharedRef< IMessageTransport, ESPMode::ThreadSafe > &Transport)=0
virtual TSharedPtr< IMessageBus, ESPMode::ThreadSafe >	CreateBus (const TSharedPtr< IAuthorizeMessageRecipients > &RecipientAuthorizer=nullptr)=0
virtual TSharedPtr< IMessageBus, ESPMode::ThreadSafe >	CreateBus (FString InName, const TSharedPtr< IAuthorizeMessageRecipients > &RecipientAuthorizer=nullptr)=0
virtual TSharedPtr< IMessageBus, ESPMode::ThreadSafe >	GetDefaultBus () const =0
virtual TArray< TSharedRef< IMessageBus, ESPMode::ThreadSafe > >	GetAllBuses () const =0
virtual	~IMessagingModule ()
Public Member Functions inherited from IModuleInterface
virtual	~IModuleInterface ()
virtual void	StartupModule ()
virtual void	PreUnloadCallback ()
virtual void	PostLoadCallback ()
virtual void	ShutdownModule ()
virtual bool	SupportsDynamicReloading ()
virtual bool	SupportsAutomaticShutdown ()
virtual bool	IsGameModule () const

Static Public Member Functions
static IMessagingModule &	Get ()

Detailed Description

Interface for messaging modules.

See also

IMessageBridge, IMessageBus

Constructor & Destructor Documentation

~IMessagingModule()

virtual IMessagingModule::~IMessagingModule ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

CreateBridge()

virtual TSharedPtr< IMessageBridge, ESPMode::ThreadSafe > IMessagingModule::CreateBridge ( const FMessageAddress &  Address, const TSharedRef< IMessageBus, ESPMode::ThreadSafe > &  Bus, const TSharedRef< IMessageTransport, ESPMode::ThreadSafe > &  Transport  )

pure virtual

Creates a new message bridge.

Message bridges translate messages between a message bus and another means of message transportation, such as network sockets.

Parameters

Address	The bridge's address on the message bus.
Bus	The message bus to attach the bridge to.
Transport	The message transport technology to use.

Returns

The new message bridge, or nullptr if the bridge couldn't be created.

See also

CreateBus

Implemented in FMessagingModule.

CreateBus() [1/2]

virtual TSharedPtr< IMessageBus, ESPMode::ThreadSafe > IMessagingModule::CreateBus ( const TSharedPtr< IAuthorizeMessageRecipients > &  RecipientAuthorizer = nullptr )

pure virtual

Creates a new message bus.

Parameters

RecipientAuthorizer

An optional recipient authorizer.

Returns

The new message bus, or nullptr if the bus couldn't be created.

See also

CreateBridge

Implemented in FMessagingModule.

CreateBus() [2/2]

virtual TSharedPtr< IMessageBus, ESPMode::ThreadSafe > IMessagingModule::CreateBus ( FString  InName, const TSharedPtr< IAuthorizeMessageRecipients > &  RecipientAuthorizer = nullptr  )

pure virtual

Creates a new message bus.

Parameters

Name	The name of this message bus.
RecipientAuthorizer	An optional recipient authorizer.

Returns

The new message bus, or nullptr if the bus couldn't be created.

See also

CreateBridge

Implemented in FMessagingModule.

DECLARE_MULTICAST_DELEGATE_OneParam()

IMessagingModule::DECLARE_MULTICAST_DELEGATE_OneParam	(	FOnMessageBusStartupOrShutdown	,
		FMessageBusWeakPtr
	)

Get()

static IMessagingModule & IMessagingModule::Get ( )

inlinestatic

Gets a reference to the messaging module instance.

Returns

A reference to the Messaging module.

GetAllBuses()

virtual TArray< TSharedRef< IMessageBus, ESPMode::ThreadSafe > > IMessagingModule::GetAllBuses ( ) const

pure virtual

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

Returns

All message buses.

Implemented in FMessagingModule.

GetDefaultBus()

virtual TSharedPtr< IMessageBus, ESPMode::ThreadSafe > IMessagingModule::GetDefaultBus ( ) const

pure virtual

Gets the default message bus if it has been initialized.

Returns

The default bus.

Implemented in FMessagingModule.

OnMessageBusShutdown()

virtual FOnMessageBusStartupOrShutdown & IMessagingModule::OnMessageBusShutdown ( )

pure virtual

Event triggered when a message bus is shutdown.

Implemented in FMessagingModule.

OnMessageBusStartup()

virtual FOnMessageBusStartupOrShutdown & IMessagingModule::OnMessageBusStartup ( )

pure virtual

Event triggered when a message bus is started.

Implemented in FMessagingModule.

---

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

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