#include <MessageBus.h>

Inheritance diagram for FMessageBus:

Public Member Functions
	FMessageBus (FString InName, const TSharedPtr< IAuthorizeMessageRecipients > &InRecipientAuthorizer)

virtual	~FMessageBus ()

virtual void	Forward (const TSharedRef< IMessageContext, ESPMode::ThreadSafe > &Context, const TArray< FMessageAddress > &Recipients, const FTimespan &Delay, const TSharedRef< IMessageSender, ESPMode::ThreadSafe > &Forwarder) override

virtual TSharedRef< IMessageTracer, ESPMode::ThreadSafe >	GetTracer () override

virtual void	Intercept (const TSharedRef< IMessageInterceptor, ESPMode::ThreadSafe > &Interceptor, const FTopLevelAssetPath &MessageType) override

virtual FOnMessageBusShutdown &	OnShutdown () override

virtual void	Publish (void Message, UScriptStruct TypeInfo, EMessageScope Scope, const TMap< FName, FString > &Annotations, const FTimespan &Delay, const FDateTime &Expiration, const TSharedRef< IMessageSender, ESPMode::ThreadSafe > &Publisher) override

virtual void	Register (const FMessageAddress &Address, const TSharedRef< IMessageReceiver, ESPMode::ThreadSafe > &Recipient) override

virtual void	Send (void Message, UScriptStruct TypeInfo, EMessageFlags Flags, const TMap< FName, FString > &Annotations, const TSharedPtr< IMessageAttachment, ESPMode::ThreadSafe > &Attachment, const TArray< FMessageAddress > &Recipients, const FTimespan &Delay, const FDateTime &Expiration, const TSharedRef< IMessageSender, ESPMode::ThreadSafe > &Sender) override

virtual void	Shutdown () override

virtual TSharedPtr< IMessageSubscription, ESPMode::ThreadSafe >	Subscribe (const TSharedRef< IMessageReceiver, ESPMode::ThreadSafe > &Subscriber, const FTopLevelAssetPath &MessageType, const FMessageScopeRange &ScopeRange) override

virtual void	Unintercept (const TSharedRef< IMessageInterceptor, ESPMode::ThreadSafe > &Interceptor, const FTopLevelAssetPath &MessageType) override

virtual void	Unregister (const FMessageAddress &Address) override

virtual void	Unsubscribe (const TSharedRef< IMessageReceiver, ESPMode::ThreadSafe > &Subscriber, const FTopLevelAssetPath &MessageType) override

virtual void	AddNotificationListener (const TSharedRef< IBusListener, ESPMode::ThreadSafe > &Listener) override

virtual void	RemoveNotificationListener (const TSharedRef< IBusListener, ESPMode::ThreadSafe > &Listener) override

virtual const FString &	GetName () const override

Public Member Functions inherited from TSharedFromThis< FMessageBus, ESPMode::ThreadSafe >
TSharedRef< FMessageBus, Mode >	AsShared ()

TSharedRef< FMessageBus const, Mode >	AsShared () const

TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const

TWeakPtr< FMessageBus, Mode >	AsWeak ()

TWeakPtr< FMessageBus const, Mode >	AsWeak () const

TWeakPtr< SubobjectType, Mode >	AsWeakSubobject (SubobjectType *SubobjectPtr) const

void	UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const InSharedPtr, OtherType InObject) const

void	UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const InSharedRef, OtherType InObject) const

UE_FORCEINLINE_HINT bool	DoesSharedInstanceExist () const

Public Member Functions inherited from IMessageBus
virtual MESSAGING_API void	Intercept (const TSharedRef< IMessageInterceptor, ESPMode::ThreadSafe > &Interceptor, const FName &MessageType)

virtual MESSAGING_API TSharedPtr< IMessageSubscription, ESPMode::ThreadSafe >	Subscribe (const TSharedRef< IMessageReceiver, ESPMode::ThreadSafe > &Subscriber, const FName &MessageType, const TRange< EMessageScope > &ScopeRange)

virtual MESSAGING_API void	Unintercept (const TSharedRef< IMessageInterceptor, ESPMode::ThreadSafe > &Interceptor, const FName &MessageType)

virtual MESSAGING_API void	Unsubscribe (const TSharedRef< IMessageReceiver, ESPMode::ThreadSafe > &Subscriber, const FName &MessageType)

virtual	~IMessageBus ()

Additional Inherited Members
Static Public Attributes inherited from IMessageBus
static MESSAGING_API const FTopLevelAssetPath	PATHNAME_All

Protected Member Functions inherited from TSharedFromThis< FMessageBus, ESPMode::ThreadSafe >
	TSharedFromThis ()

	TSharedFromThis (TSharedFromThis const &)

UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)

	~TSharedFromThis ()

Static Protected Member Functions inherited from TSharedFromThis< FMessageBus, ESPMode::ThreadSafe >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)

static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)

Detailed Description

Implements a message bus.

Constructor & Destructor Documentation

◆ FMessageBus()

FMessageBus::FMessageBus	(	FString	InName,
		const TSharedPtr< IAuthorizeMessageRecipients > &	InRecipientAuthorizer
	)

Creates and initializes a new instance.

Parameters

InDebugName	The debug name of this message bus.
InRecipientAuthorizer	An optional recipient authorizer.

◆ ~FMessageBus()

FMessageBus::~FMessageBus ( )

virtual

Virtual destructor.

Member Function Documentation

◆ AddNotificationListener()

void FMessageBus::AddNotificationListener ( const TSharedRef< IBusListener, ESPMode::ThreadSafe > & Listener )

overridevirtual

Add a listener to the bus notifications

Parameters

Listener The listener to as to the registration notifications

Implements IMessageBus.

◆ Forward()

void FMessageBus::Forward	(	const TSharedRef< IMessageContext, ESPMode::ThreadSafe > &	Context,
		const TArray< FMessageAddress > &	Recipients,
		const FTimespan &	Delay,
		const TSharedRef< IMessageSender, ESPMode::ThreadSafe > &	Forwarder
	)

overridevirtual

Forwards a previously received message.

Messages can only be forwarded to endpoints within the same process.

Parameters

Context	The context of the message to forward.
Recipients	The list of message recipients to forward the message to.
Delay	The deferral time.
Forwarder	The sender that forwards the message.

See also: Publish, Send

Implements IMessageBus.

◆ GetName()

const FString & FMessageBus::GetName ( ) const

overridevirtual

Returns: The name of this message bus.

Implements IMessageBus.

◆ GetTracer()

TSharedRef< IMessageTracer, ESPMode::ThreadSafe > FMessageBus::GetTracer ( )

overridevirtual

Gets the message bus tracer.

Returns: Weak pointer to the tracer object.

Implements IMessageBus.

◆ Intercept()

void FMessageBus::Intercept	(	const TSharedRef< IMessageInterceptor, ESPMode::ThreadSafe > &	Interceptor,
		const FTopLevelAssetPath &	MessageType
	)

overridevirtual

Adds an interceptor for messages of the specified type.

Parameters

Interceptor	The interceptor.
MessageType	The type of messages to intercept.

See also: Unintercept

Implements IMessageBus.

◆ OnShutdown()

FOnMessageBusShutdown & FMessageBus::OnShutdown ( )

overridevirtual

Returns a delegate that is executed when the message bus is shutting down.

Returns: The delegate.

See also: Shutdown

Implements IMessageBus.

◆ Publish()

void FMessageBus::Publish	(	void *	Message,
		UScriptStruct *	TypeInfo,
		EMessageScope	Scope,
		const TMap< FName, FString > &	Annotations,
		const FTimespan &	Delay,
		const FDateTime &	Expiration,
		const TSharedRef< IMessageSender, ESPMode::ThreadSafe > &	Publisher
	)

overridevirtual

Sends a message to subscribed recipients.

The bus takes over ownership of the message's memory. It must NOT be freed by the caller.

Parameters

Message	The message to publish.
TypeInfo	The message's type information.
Scope	The message scope.
Annotations	An optional message annotations header.
Delay	The delay after which to send the message.
Expiration	The time at which the message expires.
Publisher	The message publisher.

See also: Forward, Send

Implements IMessageBus.

◆ Register()

void FMessageBus::Register	(	const FMessageAddress &	Address,
		const TSharedRef< IMessageReceiver, ESPMode::ThreadSafe > &	Recipient
	)

overridevirtual

Registers a message recipient with the message bus.

Parameters

Address	The address of the recipient to register.
Recipient	The message recipient.

See also: Unregister

Implements IMessageBus.

◆ RemoveNotificationListener()

void FMessageBus::RemoveNotificationListener ( const TSharedRef< IBusListener, ESPMode::ThreadSafe > & Listener )

overridevirtual

Remove a listener to the bus notifications

Parameters

Listener The listener to remove from the registration notifications

Implements IMessageBus.

◆ Send()

void FMessageBus::Send	(	void *	Message,
		UScriptStruct *	TypeInfo,
		EMessageFlags	Flags,
		const TMap< FName, FString > &	Annotations,
		const TSharedPtr< IMessageAttachment, ESPMode::ThreadSafe > &	Attachment,
		const TArray< FMessageAddress > &	Recipients,
		const FTimespan &	Delay,
		const FDateTime &	Expiration,
		const TSharedRef< IMessageSender, ESPMode::ThreadSafe > &	Sender
	)

overridevirtual

Sends a message to multiple recipients.

The bus takes over ownership of the message's memory. It must NOT be freed by the caller.

Parameters

Message	The message to send.
TypeInfo	The message's type information.
Flags	The message flags.
Annotations	An optional message annotations header.
Attachment	The binary data to attach to the message.
Recipients	The list of message recipients.
Delay	The delay after which to send the message.
Expiration	The time at which the message expires.
Sender	The message sender.

See also: Forward, Publish

Implements IMessageBus.

◆ Shutdown()

void FMessageBus::Shutdown ( )

overridevirtual

Shuts down the message bus.

See also: OnShutdown

Implements IMessageBus.

◆ Subscribe()

TSharedPtr< IMessageSubscription, ESPMode::ThreadSafe > FMessageBus::Subscribe	(	const TSharedRef< IMessageReceiver, ESPMode::ThreadSafe > &	Subscriber,
		const FTopLevelAssetPath &	MessageType,
		const FMessageScopeRange &	ScopeRange
	)

overridevirtual

Adds a subscription for published messages of the specified type.

Subscriptions allow message consumers to receive published messages from the message bus. The returned interface can be used to query the subscription's details and its enabled state.

Parameters

Subscriber	The subscriber wishing to receive the messages.
MessageType	The type of messages to subscribe to (IMessageBus::PATHNAME_All = subscribe to all message types).
ScopeRange	The range of message scopes to include in the subscription.

Returns: The added subscription, or nullptr if the subscription failed.

See also: Unsubscribe

Implements IMessageBus.

◆ Unintercept()

void FMessageBus::Unintercept	(	const TSharedRef< IMessageInterceptor, ESPMode::ThreadSafe > &	Interceptor,
		const FTopLevelAssetPath &	MessageType
	)

overridevirtual

Removes an interceptor for messages of the specified type.

Parameters

Interceptor	The interceptor to remove.
MessageType	The type of messages to stop intercepting.

See also: Intercept

Implements IMessageBus.

◆ Unregister()

void FMessageBus::Unregister ( const FMessageAddress & Address )

overridevirtual

Unregisters a message recipient from the message bus.

Parameters

Address The address of the recipient to unregister.

See also: Register

Implements IMessageBus.

◆ Unsubscribe()

void FMessageBus::Unsubscribe	(	const TSharedRef< IMessageReceiver, ESPMode::ThreadSafe > &	Subscriber,
		const FTopLevelAssetPath &	MessageType
	)

overridevirtual

Cancels the specified message subscription.

Parameters

Subscriber	The subscriber wishing to stop receiving the messages.
MessageType	The type of messages to unsubscribe from (IMessageBus::PATHNAME_All = all types).

See also: Subscribe

Implements IMessageBus.

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

Engine/Source/Runtime/Messaging/Private/Bus/MessageBus.h
Engine/Source/Runtime/Messaging/Private/Bus/MessageBus.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FMessageBus()

◆ ~FMessageBus()

Member Function Documentation

◆ AddNotificationListener()

◆ Forward()

◆ GetName()

◆ GetTracer()

◆ Intercept()

◆ OnShutdown()

◆ Publish()

◆ Register()

◆ RemoveNotificationListener()

◆ Send()

◆ Shutdown()

◆ Subscribe()

◆ Unintercept()

◆ Unregister()

◆ Unsubscribe()