IMessageContext

Unreal Engine C++ API Reference > Runtime > Messaging

Inheritance Hierarchy

References


Module	Messaging
Header	/Engine/Source/Runtime/Messaging/Public/IMessageContext.h
Include	#include "IMessageContext.h"

Syntax

class IMessageContext

Remarks

Interface for message contexts.

Messages are delivered inside message contexts, which store the message itself plus additional data associated with the message. Recipients of a message are usually interested in data that describes the message, such as its origin or when it expires. They may also be interested in optional out-of-band binary data that is attached to the message.

The sender's address (IMessageContext.GetSender) is often needed to send a reply message to a message sender, i.e. in response to a published message. The message attachment (IMessageContext.GetAttachment) is an optional bundle of binary bulk data that is transferred independently from the message itself and allows for transferring larger amounts of data that would otherwise clog up the messaging system.

In case a message was forwarded by another endpoint, the context of the original sender can be accessed using the IMessageContext.GetOriginalContext method.

Destructors

	Type	Name	Description
		~IMessageContext ()	Virtual destructor.

Functions

Type	Name	Description
const TMap< FName, FString > &	GetAnnotations ()	Gets the optional message annotations.
TSharedPtr< IMessageAttachment, ESPMode::ThreadSafe >	GetAttachment ()	Gets the message attachment, if present.
const FDateTime &	GetExpiration ()	Gets the date and time at which the message expires.
EMessageFlags	GetFlags ()	Gets the scope to which the message was sent.
const FMessageAddress &	GetForwarder ()	Gets the forwarder's address. Identical to GetSender if the message wasn't forwarded.
const void *	GetMessage ()	Gets the message data.
const TWeakObjectPtr< UScriptStruct > &	GetMessageTypeInfo ()	Gets the message's type information.
FTopLevelAssetPath	GetMessageTypePathName ()	Gets the path name of the message type.
TSharedPtr< IMessageContext, ESPMode::ThreadSafe >	GetOriginalContext ()	Returns the original message context in case the message was forwarded.
const TArray< FMessageAddress > &	GetRecipients ()	Gets the list of message recipients.
EMessageScope	GetScope ()	Gets the scope to which the message was sent.
const FMessageAddress &	GetSender ()	Gets the sender's address.
ENamedThreads::Type	GetSenderThread ()	Gets the name of the thread from which the message was sent.
const FDateTime &	GetTimeForwarded ()	Gets the time at which the message was forwarded.
const FDateTime &	GetTimeSent ()	Gets the time at which the message was sent.
bool	IsForwarded ()	Checks whether this is a forwarded message.
bool	IsValid ()	Checks whether this context is valid.