IAuthorizeMessageRecipients Class Reference

#include <IAuthorizeMessageRecipients.h>

Public Member Functions
virtual bool	AuthorizeInterceptor (const TSharedRef< IMessageInterceptor, ESPMode::ThreadSafe > &Interceptor, const FName &MessageType)
virtual bool	AuthorizeInterceptor (const TSharedRef< IMessageInterceptor, ESPMode::ThreadSafe > &Interceptor, const FTopLevelAssetPath &MessageType)=0
virtual bool	AuthorizeRegistration (const TSharedRef< IMessageReceiver, ESPMode::ThreadSafe > &Recipient, const FMessageAddress &Address)=0
virtual bool	AuthorizeSubscription (const TSharedRef< IMessageReceiver, ESPMode::ThreadSafe > &Subscriber, const FName &TopicPattern)
virtual bool	AuthorizeSubscription (const TSharedRef< IMessageReceiver, ESPMode::ThreadSafe > &Subscriber, const FTopLevelAssetPath &TopicPattern)=0
virtual bool	AuthorizeUnregistration (const FMessageAddress &Address)=0
virtual bool	AuthorizeUnsubscription (const TSharedRef< IMessageReceiver, ESPMode::ThreadSafe > &Subscriber, const FName &TopicPattern)
virtual bool	AuthorizeUnsubscription (const TSharedRef< IMessageReceiver, ESPMode::ThreadSafe > &Subscriber, const FTopLevelAssetPath &TopicPattern)=0
virtual	~IAuthorizeMessageRecipients ()

Detailed Description

Interface for classes that authorize message subscriptions.

Constructor & Destructor Documentation

~IAuthorizeMessageRecipients()

virtual IAuthorizeMessageRecipients::~IAuthorizeMessageRecipients ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

AuthorizeInterceptor() [1/2]

virtual bool IAuthorizeMessageRecipients::AuthorizeInterceptor ( const TSharedRef< IMessageInterceptor, ESPMode::ThreadSafe > &  Interceptor, const FName &  MessageType  )

inlinevirtual

Authorizes a request to intercept messages of the specified type.

Parameters

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

Returns

true if the request was authorized, false otherwise.

AuthorizeInterceptor() [2/2]

virtual bool IAuthorizeMessageRecipients::AuthorizeInterceptor ( const TSharedRef< IMessageInterceptor, ESPMode::ThreadSafe > &  Interceptor, const FTopLevelAssetPath &  MessageType  )

pure virtual

Authorizes a request to intercept messages of the specified type.

Parameters

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

Returns

true if the request was authorized, false otherwise.

AuthorizeRegistration()

virtual bool IAuthorizeMessageRecipients::AuthorizeRegistration ( const TSharedRef< IMessageReceiver, ESPMode::ThreadSafe > &  Recipient, const FMessageAddress &  Address  )

pure virtual

Authorizes a request to register the specified recipient.

Parameters

Recipient	The recipient to register.
Address	The recipient's address.

Returns

true if the request was authorized, false otherwise.

AuthorizeSubscription() [1/2]

virtual bool IAuthorizeMessageRecipients::AuthorizeSubscription ( const TSharedRef< IMessageReceiver, ESPMode::ThreadSafe > &  Subscriber, const FName &  TopicPattern  )

inlinevirtual

Authorizes a request to add a subscription for the specified topic pattern.

Parameters

Subscriber	The subscriber.
TopicPattern	The message topic pattern to subscribe to.

Returns

true if the request is authorized, false otherwise.

AuthorizeSubscription() [2/2]

virtual bool IAuthorizeMessageRecipients::AuthorizeSubscription ( const TSharedRef< IMessageReceiver, ESPMode::ThreadSafe > &  Subscriber, const FTopLevelAssetPath &  TopicPattern  )

pure virtual

Authorizes a request to add a subscription for the specified topic pattern.

Parameters

Subscriber	The subscriber.
TopicPattern	The message topic pattern to subscribe to.

Returns

true if the request is authorized, false otherwise.

AuthorizeUnregistration()

virtual bool IAuthorizeMessageRecipients::AuthorizeUnregistration ( const FMessageAddress &  Address )

pure virtual

Authorizes a request to unregister the specified recipient.

Parameters

Address

The address of the recipient to unregister.

Returns

true if the request was authorized, false otherwise.

AuthorizeUnsubscription() [1/2]

virtual bool IAuthorizeMessageRecipients::AuthorizeUnsubscription ( const TSharedRef< IMessageReceiver, ESPMode::ThreadSafe > &  Subscriber, const FName &  TopicPattern  )

inlinevirtual

Authorizes a request to remove a subscription for the specified topic pattern.

Parameters

Subscriber	The subscriber.
TopicPattern	The message topic pattern to unsubscribe from.

Returns

true if the request is authorized, false otherwise.

AuthorizeUnsubscription() [2/2]

virtual bool IAuthorizeMessageRecipients::AuthorizeUnsubscription ( const TSharedRef< IMessageReceiver, ESPMode::ThreadSafe > &  Subscriber, const FTopLevelAssetPath &  TopicPattern  )

pure virtual

Authorizes a request to remove a subscription for the specified topic pattern.

Parameters

Subscriber	The subscriber.
TopicPattern	The message topic pattern to unsubscribe from.

Returns

true if the request is authorized, false otherwise.

---

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

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