IConcertMessage

Abstract for Concert Message

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

ConcertTransport

Header

/Engine/Plugins/Developer/Concert/ConcertMain/Source/ConcertTransport/Public/IConcertMessages.h

Include

#include "IConcertMessages.h"

Syntax

class IConcertMessage

Remarks

Abstract for Concert Message

Destructors

Name Description

Public function Virtual

~IConcertMessage()

Functions

Name Description

Public function

void

 

Acknowledge

(
    const FConcertMessageContext& Conc...
)

Acknowledge the message

Public function Const

void *

 

ConstructMessage()

Construct this message data, allocates memory

Public function Const

const TMap< ...

 

GetAnnotations()

Annotations for sending across message bus

Public function Const

uint16

 

GetChannelId()

Get the ID of the channel this message was sent from

Public function Const

FDateTime

 

GetCreationDate()

Get the Creation time of the message

Public function Const

FGuid

 

GetMessageId()

Get the ID of the message

Public function Const

uint16

 

GetMessageOrderIndex()

Get the order index of the message (for ordering reliable messages, used when ChannelId != UnreliableChannelId)

Public function Const

const void &...

 

GetMessageTemplate()

Get the template of the message that will be created with ConstructMessage

Public function Const

UScriptStruc...

 

GetMessageType()

Get the message type of the data allocated with ConstructMessage

Public function Const

const FGuid ...

 

GetSenderId()

Get the Concert Endpoint Id of the sender

Public function Const

EConcertMess...

 

GetState()

Get the message state

Public function Const

EConcertMess...

 

GetType()

Get the message type

Public function Const

bool

 

IsReliable()

Get is the message is flagged a reliable

Public function

void

 

SetAnnotations

(
    TMap< FName, FString > Annotations
)

Annotations associated with this message.

Protected function

void

 

SetChannelId

(
    uint16 Channel
)

Set the ID of the channel this message was sent from. Call before ConstructMessage.

Protected function

void

 

SetMessageId

(
    const FGuid& MessageId
)

Set the ID of the message. Call before ConstructMessage.

Protected function

void

 

SetOrderIndex

(
    uint16 OrderIndex
)

Set the order index of the message (for ordering reliable messages, used when ChannelId != UnreliableChannelId).

Protected function

void

 

SetSenderId

(
    const FGuid& SenderId
)

Set the Concert Endpoint Id of the sender. Call before ConstructMessage.

Public function

void

 

TimeOut()

Timeout the message