FMessagingModule Class Reference

Inheritance diagram for FMessagingModule:

Public Member Functions
virtual FOnMessageBusStartupOrShutdown &	OnMessageBusStartup () override
virtual FOnMessageBusStartupOrShutdown &	OnMessageBusShutdown () override
virtual TSharedPtr< IMessageBridge, ESPMode::ThreadSafe >	CreateBridge (const FMessageAddress &Address, const TSharedRef< IMessageBus, ESPMode::ThreadSafe > &Bus, const TSharedRef< IMessageTransport, ESPMode::ThreadSafe > &Transport) override
virtual TSharedPtr< IMessageBus, ESPMode::ThreadSafe >	CreateBus (const TSharedPtr< IAuthorizeMessageRecipients > &RecipientAuthorizer) override
virtual TSharedPtr< IMessageBus, ESPMode::ThreadSafe >	CreateBus (FString InName, const TSharedPtr< IAuthorizeMessageRecipients > &RecipientAuthorizer) override
virtual TSharedPtr< IMessageBus, ESPMode::ThreadSafe >	GetDefaultBus () const override
virtual TArray< TSharedRef< IMessageBus, ESPMode::ThreadSafe > >	GetAllBuses () const override
virtual void	StartupModule () override
virtual void	ShutdownModule () override
virtual bool	SupportsDynamicReloading () override
Public Member Functions inherited from FSelfRegisteringExec
CORE_API	FSelfRegisteringExec ()
virtual CORE_API	~FSelfRegisteringExec ()
Public Member Functions inherited from FExec
virtual CORE_API	~FExec ()
virtual CORE_API bool	Exec (UWorld *InWorld, const TCHAR *Cmd, FOutputDevice &Ar)
Public Member Functions inherited from IMessagingModule
	DECLARE_MULTICAST_DELEGATE_OneParam (FOnMessageBusStartupOrShutdown, FMessageBusWeakPtr)
virtual	~IMessagingModule ()
Public Member Functions inherited from IModuleInterface
virtual	~IModuleInterface ()
virtual void	PreUnloadCallback ()
virtual void	PostLoadCallback ()
virtual bool	SupportsAutomaticShutdown ()
virtual bool	IsGameModule () const

Protected Member Functions
virtual bool	Exec_Runtime (UWorld *InWorld, const TCHAR *Cmd, FOutputDevice &Ar) override
void	ShutdownDefaultBus ()
Protected Member Functions inherited from FExec
virtual bool	Exec_Dev (UWorld *InWorld, const TCHAR *Cmd, FOutputDevice &Ar)
virtual bool	Exec_Editor (UWorld *InWorld, const TCHAR *Cmd, FOutputDevice &Ar)

Additional Inherited Members
Static Public Member Functions inherited from FSelfRegisteringExec
static CORE_API bool	StaticExec (UWorld *Inworld, const TCHAR *Cmd, FOutputDevice &Ar)
Static Public Member Functions inherited from IMessagingModule
static IMessagingModule &	Get ()

Detailed Description

Implements the Messaging module.

Member Function Documentation

CreateBridge()

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

inlineoverridevirtual

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

Implements IMessagingModule.

CreateBus() [1/2]

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

inlineoverridevirtual

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

Implements IMessagingModule.

CreateBus() [2/2]

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

inlineoverridevirtual

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

Implements IMessagingModule.

Exec_Runtime()

virtual bool FMessagingModule::Exec_Runtime ( UWorld *  InWorld, const TCHAR *  Cmd, FOutputDevice &  Ar  )

inlineoverrideprotectedvirtual

Implementation of Exec that is called on all targets where UE_ALLOW_EXEC_COMMANDS is true

Reimplemented from FExec.

GetAllBuses()

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

inlineoverridevirtual

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

Returns

All message buses.

Implements IMessagingModule.

GetDefaultBus()

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

inlineoverridevirtual

Gets the default message bus if it has been initialized.

Returns

The default bus.

Implements IMessagingModule.

OnMessageBusShutdown()

virtual FOnMessageBusStartupOrShutdown & FMessagingModule::OnMessageBusShutdown ( )

inlineoverridevirtual

Event triggered when a message bus is shutdown.

Implements IMessagingModule.

OnMessageBusStartup()

virtual FOnMessageBusStartupOrShutdown & FMessagingModule::OnMessageBusStartup ( )

inlineoverridevirtual

Event triggered when a message bus is started.

Implements IMessagingModule.

ShutdownDefaultBus()

void FMessagingModule::ShutdownDefaultBus ( )

inlineprotected

ShutdownModule()

virtual void FMessagingModule::ShutdownModule ( )

inlineoverridevirtual

Called before the module is unloaded, right before the module object is destroyed. During normal shutdown, this is called in reverse order that modules finish StartupModule(). This means that, as long as a module references dependent modules in it's StartupModule(), it can safely reference those dependencies in ShutdownModule() as well.

Reimplemented from IModuleInterface.

StartupModule()

virtual void FMessagingModule::StartupModule ( )

inlineoverridevirtual

Called right after the module DLL has been loaded and the module object has been created Load dependent modules here, and they will be guaranteed to be available during ShutdownModule. ie:

FModuleManager::Get().LoadModuleChecked(TEXT("HTTP"));

Reimplemented from IModuleInterface.

SupportsDynamicReloading()

virtual bool FMessagingModule::SupportsDynamicReloading ( )

inlineoverridevirtual

Override this to set whether your module is allowed to be unloaded on the fly

Returns

Whether the module supports shutdown separate from the rest of the engine.

Reimplemented from IModuleInterface.

---

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

• Engine/Source/Runtime/Messaging/Private/MessagingModule.cpp