IMessageSubscription Class Reference

#include <IMessageSubscription.h>

Inheritance diagram for IMessageSubscription:

Public Member Functions
virtual void	Disable ()=0
virtual void	Enable ()=0
FName	GetMessageType ()
virtual FTopLevelAssetPath	GetMessageTypePathName ()=0
virtual const TRange< EMessageScope > &	GetScopeRange ()=0
virtual const TWeakPtr< IMessageReceiver, ESPMode::ThreadSafe > &	GetSubscriber ()=0
virtual bool	IsEnabled ()=0
virtual	~IMessageSubscription ()

Detailed Description

Interface for message subscriptions.

This interface provides access to a message subscription that was previously created with the IMessageBus.Subscribe method. It can be used to query the subscription's details using the various getters and modify its enabled state using the IMessageSubscription.Enable and IMessageSubscription.Disable methods.

A subscription that is disabled will cause a message endpoint to stop receiving messages for the subscribed message type. However, the subscription is merely disabled and not removed.

Constructor & Destructor Documentation

~IMessageSubscription()

virtual IMessageSubscription::~IMessageSubscription ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

Disable()

virtual void IMessageSubscription::Disable ( )

pure virtual

Disables the subscription.

See also

Enable, IsEnabled

Implemented in FMessageSubscription.

Enable()

virtual void IMessageSubscription::Enable ( )

pure virtual

Enables the subscription.

See also

Disable, IsEnabled

Implemented in FMessageSubscription.

GetMessageType()

FName IMessageSubscription::GetMessageType ( )

inline

Gets the type of subscribed messages.

Returns

Message type.

See also

GetScopeRange, GetSubscriber

GetMessageTypePathName()

virtual FTopLevelAssetPath IMessageSubscription::GetMessageTypePathName ( )

pure virtual

Gets the type of subscribed messages.

Returns

Message type.

See also

GetScopeRange, GetSubscriber

Implemented in FMessageSubscription.

GetScopeRange()

virtual const TRange< EMessageScope > & IMessageSubscription::GetScopeRange ( )

pure virtual

Gets the range of subscribed message scopes.

Returns

Message scope range.

See also

GetMessageType, GetSubscriber

Implemented in FMessageSubscription.

GetSubscriber()

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

pure virtual

Gets the subscriber.

Returns

The subscriber.

See also

GetMessageType, GetScopeRange

Implemented in FMessageSubscription.

IsEnabled()

virtual bool IMessageSubscription::IsEnabled ( )

pure virtual

Checks whether the subscription is enabled.

Returns

true if the subscription is enabled, false otherwise.

See also

Enable, Disable

Implemented in FMessageSubscription.

---

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

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