Navigation
API > API/Plugins > API/Plugins/ConcertTransport
Abstract for Concert Message
| Name | IConcertMessage |
| Type | class |
| Header File | /Engine/Plugins/Developer/Concert/ConcertMain/Source/ConcertTransport/Public/IConcertMessages.h |
| Include Path | #include "IConcertMessages.h" |
Syntax
class IConcertMessage
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IConcertMessage() |
IConcertMessages.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Acknowledge
(
const FConcertMessageContext& ConcertContext |
Acknowledge the message | IConcertMessages.h | |
void * ConstructMessage() |
Construct this message data, allocates memory | IConcertMessages.h | |
| Annotations for sending across message bus | IConcertMessages.h | ||
uint16 GetChannelId() |
Get the ID of the channel this message was sent from | IConcertMessages.h | |
FDateTime GetCreationDate() |
Get the Creation time of the message | IConcertMessages.h | |
FGuid GetMessageId() |
Get the ID of the message | IConcertMessages.h | |
uint16 GetMessageOrderIndex() |
Get the order index of the message (for ordering reliable messages, used when ChannelId != UnreliableChannelId) | IConcertMessages.h | |
const void * GetMessageTemplate() |
Get the template of the message that will be created with ConstructMessage | IConcertMessages.h | |
UScriptStruct * GetMessageType() |
Get the message type of the data allocated with ConstructMessage | IConcertMessages.h | |
const FGuid & GetSenderId() |
Get the Concert Endpoint Id of the sender | IConcertMessages.h | |
EConcertMessageState GetState() |
Get the message state | IConcertMessages.h | |
EConcertMessageType GetType() |
Get the message type | IConcertMessages.h | |
bool IsReliable() |
Get is the message is flagged a reliable | IConcertMessages.h | |
| Annotations associated with this message. | IConcertMessages.h | ||
void TimeOut() |
Timeout the message | IConcertMessages.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void SetChannelId
(
uint16 Channel |
Set the ID of the channel this message was sent from. Call before ConstructMessage. | IConcertMessages.h | |
void SetMessageId
(
const FGuid& MessageId |
Set the ID of the message. Call before ConstructMessage. | IConcertMessages.h | |
void SetOrderIndex
(
uint16 OrderIndex |
Set the order index of the message (for ordering reliable messages, used when ChannelId != UnreliableChannelId). | IConcertMessages.h | |
void SetSenderId
(
const FGuid& SenderId |
Set the Concert Endpoint Id of the sender. Call before ConstructMessage. | IConcertMessages.h |