UE::Net::FNetBlobAssembler Class Reference

#include <NetBlobAssembler.h>

Public Member Functions
IRISCORE_API	FNetBlobAssembler ()
IRISCORE_API void	Init (const FNetBlobAssemblerInitParams &InitParams)
IRISCORE_API void	AddPartialNetBlob (FNetSerializationContext &Context, FNetRefHandle RefHandle, const TRefCountPtr< FPartialNetBlob > &PartialNetBlob)
bool	IsReadyToAssemble () const
bool	IsSequenceBroken () const
IRISCORE_API TRefCountPtr< FNetBlob >	Assemble (FNetSerializationContext &Context)

Detailed Description

Utility class to reassemble split blobs. Partial blobs need to be added in order and represent the same blob until it's assembled or an error occurs.

Constructor & Destructor Documentation

FNetBlobAssembler()

UE::Net::FNetBlobAssembler::FNetBlobAssembler

(

)

Member Function Documentation

AddPartialNetBlob()

void UE::Net::FNetBlobAssembler::AddPartialNetBlob	(	FNetSerializationContext &	Context,
		FNetRefHandle	RefHandle,
		const TRefCountPtr< FPartialNetBlob > &	PartialNetBlob
	)

Add the next expected part of the split blob. If it's the first part of a blob the effects of prior calls to this function are discarded.

Parameters

Context	FNetSerializationContext for error reporting. Call HasError() on it afterwards to check whether something went wrong.
NetHandle	The NetHandle needs to remain constant for every call until the original blob has been assembled or the first part of a new blob is added.

Assemble()

TRefCountPtr< FNetBlob > UE::Net::FNetBlobAssembler::Assemble

(

FNetSerializationContext &

Context

)

Assemble all parts of the split blob.

Parameters

Context

FNetSerializationContext for error reporting. Call HasError() on it afterwards to check whether something went wrong.

Returns

The assembled blob.

Note

IsReadyToAssemble() must return true before calling this function.

After this function has been called it may not be called again until a new blob is ready to be assembled.

Init()

void UE::Net::FNetBlobAssembler::Init

(

const FNetBlobAssemblerInitParams &

InitParams

)

Initialize the NetBlobAssembler.

IsReadyToAssemble()

bool UE::Net::FNetBlobAssembler::IsReadyToAssemble ( ) const

inline

Returns true if all parts of the split blob have been added and is ready to be assembled.

IsSequenceBroken()

bool UE::Net::FNetBlobAssembler::IsSequenceBroken ( ) const

inline

Returns true if the sequence order is broken.

---

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

• Engine/Source/Runtime/Net/Iris/Public/Iris/ReplicationSystem/NetBlob/NetBlobAssembler.h
• Engine/Source/Runtime/Net/Iris/Private/Iris/ReplicationSystem/NetBlob/NetBlobAssembler.cpp