UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FMessageSubscription Class Reference

#include <MessageSubscription.h>

+ Inheritance diagram for FMessageSubscription:

Public Member Functions

 FMessageSubscription (const TSharedRef< IMessageReceiver, ESPMode::ThreadSafe > &InSubscriber, const FTopLevelAssetPath &InMessageType, const FMessageScopeRange &InScopeRange)
 
virtual void Disable () override
 
virtual void Enable () override
 
virtual FTopLevelAssetPath GetMessageTypePathName () override
 
virtual const FMessageScopeRangeGetScopeRange () override
 
virtual const TWeakPtr< IMessageReceiver, ESPMode::ThreadSafe > & GetSubscriber () override
 
virtual bool IsEnabled () override
 
- Public Member Functions inherited from IMessageSubscription
FName GetMessageType ()
 
virtual ~IMessageSubscription ()
 

Detailed Description

Implements a message subscription.

Message subscriptions are used by the message router to determine where to dispatch published messages to. Message subscriptions are created per message type.

Constructor & Destructor Documentation

◆ FMessageSubscription()

FMessageSubscription::FMessageSubscription ( const TSharedRef< IMessageReceiver, ESPMode::ThreadSafe > &  InSubscriber,
const FTopLevelAssetPath InMessageType,
const FMessageScopeRange InScopeRange 
)
inline

Creates and initializes a new instance.

Parameters
InSubscriberThe message subscriber.
InMessageTypeThe type of messages to subscribe to.
InReceivingThreadThe thread on which to receive messages on.
InScopeRangeThe message scope range to subscribe to.

Member Function Documentation

◆ Disable()

virtual void FMessageSubscription::Disable ( )
inlineoverridevirtual

Disables the subscription.

See also
Enable, IsEnabled

Implements IMessageSubscription.

◆ Enable()

virtual void FMessageSubscription::Enable ( )
inlineoverridevirtual

Enables the subscription.

See also
Disable, IsEnabled

Implements IMessageSubscription.

◆ GetMessageTypePathName()

virtual FTopLevelAssetPath FMessageSubscription::GetMessageTypePathName ( )
inlineoverridevirtual

Gets the type of subscribed messages.

Returns
Message type.
See also
GetScopeRange, GetSubscriber

Implements IMessageSubscription.

◆ GetScopeRange()

virtual const FMessageScopeRange & FMessageSubscription::GetScopeRange ( )
inlineoverridevirtual

Gets the range of subscribed message scopes.

Returns
Message scope range.
See also
GetMessageType, GetSubscriber

Implements IMessageSubscription.

◆ GetSubscriber()

virtual const TWeakPtr< IMessageReceiver, ESPMode::ThreadSafe > & FMessageSubscription::GetSubscriber ( )
inlineoverridevirtual

Gets the subscriber.

Returns
The subscriber.
See also
GetMessageType, GetScopeRange

Implements IMessageSubscription.

◆ IsEnabled()

virtual bool FMessageSubscription::IsEnabled ( )
inlineoverridevirtual

Checks whether the subscription is enabled.

Returns
true if the subscription is enabled, false otherwise.
See also
Enable, Disable

Implements IMessageSubscription.


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