UE::Cook::FCookOnTheFlyMessage Class Reference

#include <CookOnTheFly.h>

Inheritance diagram for UE::Cook::FCookOnTheFlyMessage:

Public Member Functions
	FCookOnTheFlyMessage ()=default
	FCookOnTheFlyMessage (ECookOnTheFlyMessage MessageType)
ECookOnTheFlyMessage	GetMessageType () const
FCookOnTheFlyMessageHeader &	GetHeader ()
const FCookOnTheFlyMessageHeader &	GetHeader () const
void	SetHeader (const FCookOnTheFlyMessageHeader &InHeader)
void	SetStatus (ECookOnTheFlyMessageStatus InStatus)
ECookOnTheFlyMessageStatus	GetStatus () const
bool	IsOk () const
COOKONTHEFLY_API void	SetBody (TArray< uint8 > InBody)
template<typename BodyType >
void	SetBodyTo (BodyType InBody)
TArray< uint8 > &	GetBody ()
const TArray< uint8 > &	GetBody () const
template<typename BodyType >
BodyType	GetBodyAs () const
int64	TotalSize () const
COOKONTHEFLY_API TUniquePtr< FArchive >	ReadBody () const
COOKONTHEFLY_API TUniquePtr< FArchive >	WriteBody ()

Protected Attributes
FCookOnTheFlyMessageHeader	Header
TArray< uint8 >	Body

Friends
COOKONTHEFLY_API friend FArchive &	operator<< (FArchive &Ar, FCookOnTheFlyMessage &Message)

Detailed Description

Cook-on-the-fly message.

Constructor & Destructor Documentation

FCookOnTheFlyMessage() [1/2]

UE::Cook::FCookOnTheFlyMessage::FCookOnTheFlyMessage ( )

default

Creates a new instance of a cook-on-the-fly message.

FCookOnTheFlyMessage() [2/2]

UE::Cook::FCookOnTheFlyMessage::FCookOnTheFlyMessage ( ECookOnTheFlyMessage  MessageType )

inlineexplicit

Creates a new instance of a cook-on-the-fly message with the specified message type.

Member Function Documentation

GetBody() [1/2]

TArray< uint8 > & UE::Cook::FCookOnTheFlyMessage::GetBody ( )

inline

Returns the message body.

GetBody() [2/2]

const TArray< uint8 > & UE::Cook::FCookOnTheFlyMessage::GetBody ( ) const

inline

Returns the message body.

GetBodyAs()

template<typename BodyType >

BodyType UE::Cook::FCookOnTheFlyMessage::GetBodyAs ( ) const

inline

Serialize the body as the specified type.

GetHeader() [1/2]

FCookOnTheFlyMessageHeader & UE::Cook::FCookOnTheFlyMessage::GetHeader ( )

inline

Returns the message header.

GetHeader() [2/2]

const FCookOnTheFlyMessageHeader & UE::Cook::FCookOnTheFlyMessage::GetHeader ( ) const

inline

Returns the message header.

GetMessageType()

ECookOnTheFlyMessage UE::Cook::FCookOnTheFlyMessage::GetMessageType ( ) const

inline

GetStatus()

ECookOnTheFlyMessageStatus UE::Cook::FCookOnTheFlyMessage::GetStatus ( ) const

inline

Returns the message status.

IsOk()

bool UE::Cook::FCookOnTheFlyMessage::IsOk ( ) const

inline

Returns whether the message stauts is OK.

ReadBody()

TUniquePtr< FArchive > UE::Cook::FCookOnTheFlyMessage::ReadBody

(

)

const

Creates an archive for ready the message body.

SetBody()

void UE::Cook::FCookOnTheFlyMessage::SetBody

(

TArray< uint8 >

InBody

)

Set the message body.

SetBodyTo()

template<typename BodyType >

void UE::Cook::FCookOnTheFlyMessage::SetBodyTo ( BodyType  InBody )

inline

Set body to serializable type.

SetHeader()

void UE::Cook::FCookOnTheFlyMessage::SetHeader ( const FCookOnTheFlyMessageHeader &  InHeader )

inline

Set a new message header.

SetStatus()

void UE::Cook::FCookOnTheFlyMessage::SetStatus ( ECookOnTheFlyMessageStatus  InStatus )

inline

Sets the message status.

TotalSize()

int64 UE::Cook::FCookOnTheFlyMessage::TotalSize ( ) const

inline

Returns the total size of the message header and message body.

WriteBody()

TUniquePtr< FArchive > UE::Cook::FCookOnTheFlyMessage::WriteBody

(

)

Creates an archive for writing the message body.

Friends And Related Symbol Documentation

operator<<

COOKONTHEFLY_API friend FArchive & operator<< ( FArchive &  Ar, FCookOnTheFlyMessage &  Message  )

friend

Member Data Documentation

Body

TArray<uint8> UE::Cook::FCookOnTheFlyMessage::Body

protected

Header

FCookOnTheFlyMessageHeader UE::Cook::FCookOnTheFlyMessage::Header

protected

---

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

• Engine/Source/Runtime/CookOnTheFly/Internal/CookOnTheFly.h
• Engine/Source/Runtime/CookOnTheFly/Private/CookOnTheFly.cpp