IMessageContext

Interface for message contexts.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

IMessageContext

IMutableMessageContext

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

Name Description

Public function Virtual

~IMessageContext()

Virtual destructor.

Functions

Name Description

Public function Const

const TMap< ...

 

GetAnnotations()

Gets the optional message annotations.

Public function Const

TSharedPtr< ...

 

GetAttachment()

Gets the message attachment, if present.

Public function Const

const FDateT...

 

GetExpiration()

Gets the date and time at which the message expires.

Public function Const

EMessageFlag...

 

GetFlags()

Gets the scope to which the message was sent.

Public function Const

const FMessa...

 

GetForwarder()

Gets the forwarder's address. @note Identical to GetSender if the message wasn't forwarded.

Public function Const

const void &...

 

GetMessage()

Gets the message data.

Public function Const

FName

 

GetMessageType()

Gets the name of the message type.

Public function Const

const TWeakO...

 

GetMessageTypeInfo()

Gets the message's type information.

Public function Const

TSharedPtr< ...

 

GetOriginalContext()

Returns the original message context in case the message was forwarded.

Public function Const

const TArray...

 

GetRecipients()

Gets the list of message recipients.

Public function Const

EMessageScop...

 

GetScope()

Gets the scope to which the message was sent.

Public function Const

const FMessa...

 

GetSender()

Gets the sender's address.

Public function Const

ENamedThread...

 

GetSenderThread()

Gets the name of the thread from which the message was sent.

Public function Const

const FDateT...

 

GetTimeForwarded()

Gets the time at which the message was forwarded.

Public function Const

const FDateT...

 

GetTimeSent()

Gets the time at which the message was sent.

Public function Const

bool

 

IsForwarded()

Checks whether this is a forwarded message.

Public function Const

bool

 

IsValid()

Checks whether this context is valid.

See Also