UE::Net::Private::FDeltaCompressionBaselineManager Class Reference

#include <DeltaCompressionBaselineManager.h>

Public Types
enum	: uint32 { MaxBaselineCount = 2 }
enum	: uint32 { InvalidBaselineIndex = MaxBaselineCount }
enum	: uint32 { BaselineIndexBitCount = 2 }

Public Member Functions
	FDeltaCompressionBaselineManager ()
	~FDeltaCompressionBaselineManager ()
void	Init (FDeltaCompressionBaselineManagerInitParams &InitParams)
void	Deinit ()
void	OnMaxInternalNetRefIndexIncreased (UE::Net::Private::FInternalNetRefIndex NewMaxInternalIndex)
void	PreSendUpdate (FDeltaCompressionBaselineManagerPreSendUpdateParams &UpdateParams)
void	PostSendUpdate (FDeltaCompressionBaselineManagerPostSendUpdateParams &UpdateParams)
void	AddConnection (uint32 ConnectionId)
void	RemoveConnection (uint32 ConnectionId)
void	SetDeltaCompressionStatus (FInternalNetRefIndex Index, ENetObjectDeltaCompressionStatus Status)
ENetObjectDeltaCompressionStatus	GetDeltaCompressionStatus (FInternalNetRefIndex Index) const
uint32	GetMaxDeltaCompressedObjectCount () const
FDeltaCompressionBaseline	CreateBaseline (uint32 ConnId, uint32 ObjectIndex, uint32 BaselineIndex)
void	DestroyBaseline (uint32 ConnId, uint32 ObjectIndex, uint32 BaselineIndex)
void	LostBaseline (uint32 ConnId, uint32 ObjectIndex, uint32 BaselineIndex)
FDeltaCompressionBaseline	GetBaseline (uint32 ConnId, uint32 ObjectIndex, uint32 BaselineIndex) const
FString	PrintDeltaCompressionStatus (uint32 ConnectionId, FInternalNetRefIndex ObjectIndex) const

Member Enumeration Documentation

anonymous enum

anonymous enum : uint32

Enumerator
MaxBaselineCount

anonymous enum

anonymous enum : uint32

Enumerator
InvalidBaselineIndex

anonymous enum

anonymous enum : uint32

Enumerator
BaselineIndexBitCount

Constructor & Destructor Documentation

FDeltaCompressionBaselineManager()

UE::Net::Private::FDeltaCompressionBaselineManager::FDeltaCompressionBaselineManager

(

)

~FDeltaCompressionBaselineManager()

UE::Net::Private::FDeltaCompressionBaselineManager::~FDeltaCompressionBaselineManager

(

)

Member Function Documentation

AddConnection()

void UE::Net::Private::FDeltaCompressionBaselineManager::AddConnection

(

uint32

ConnectionId

)

CreateBaseline()

FDeltaCompressionBaseline UE::Net::Private::FDeltaCompressionBaselineManager::CreateBaseline	(	uint32	ConnId,
		uint32	ObjectIndex,
		uint32	BaselineIndex
	)

Creates a baseline if the policy allows it. May return an invalid baseline. The only guarantee is it will be valid for the current SendUpdate(). Both events outside of this manager's control and baseline policies, such as how many may exist in total and per object and how frequent state changes occur, may invalidate the baseline in the future. If unlucky a state changing conditional is enabled which forces the baseline to be invalidated as early as the next frame.

Deinit()

void UE::Net::Private::FDeltaCompressionBaselineManager::Deinit

(

)

DestroyBaseline()

void UE::Net::Private::FDeltaCompressionBaselineManager::DestroyBaseline	(	uint32	ConnId,
		uint32	ObjectIndex,
		uint32	BaselineIndex
	)

Destroys a baseline if it's valid.

GetBaseline()

FDeltaCompressionBaseline UE::Net::Private::FDeltaCompressionBaselineManager::GetBaseline	(	uint32	ConnId,
		uint32	ObjectIndex,
		uint32	BaselineIndex
	)		const

Returns a valid baseline if it exists, an invalid one if it no longer exists. The manager is free to invalidate baselines at its own discretion.

GetDeltaCompressionStatus()

ENetObjectDeltaCompressionStatus UE::Net::Private::FDeltaCompressionBaselineManager::GetDeltaCompressionStatus

(

FInternalNetRefIndex

Index

)

const

GetMaxDeltaCompressedObjectCount()

uint32 UE::Net::Private::FDeltaCompressionBaselineManager::GetMaxDeltaCompressedObjectCount ( ) const

inline

Init()

void UE::Net::Private::FDeltaCompressionBaselineManager::Init

(

FDeltaCompressionBaselineManagerInitParams &

InitParams

)

LostBaseline()

void UE::Net::Private::FDeltaCompressionBaselineManager::LostBaseline	(	uint32	ConnId,
		uint32	ObjectIndex,
		uint32	BaselineIndex
	)

Destroys a baseline if it's valid but merges the changemask into the connection specific one for this object so that a future call to GetBaseline() will include at least that changemask.

OnMaxInternalNetRefIndexIncreased()

void UE::Net::Private::FDeltaCompressionBaselineManager::OnMaxInternalNetRefIndexIncreased

(

UE::Net::Private::FInternalNetRefIndex

NewMaxInternalIndex

)

Called when the maximum InternalNetRefIndex increased and we need to realloc our lists

PostSendUpdate()

void UE::Net::Private::FDeltaCompressionBaselineManager::PostSendUpdate

(

FDeltaCompressionBaselineManagerPostSendUpdateParams &

UpdateParams

)

PreSendUpdate()

void UE::Net::Private::FDeltaCompressionBaselineManager::PreSendUpdate

(

FDeltaCompressionBaselineManagerPreSendUpdateParams &

UpdateParams

)

PrintDeltaCompressionStatus()

FString UE::Net::Private::FDeltaCompressionBaselineManager::PrintDeltaCompressionStatus	(	uint32	ConnectionId,
		FInternalNetRefIndex	ObjectIndex
	)		const

RemoveConnection()

void UE::Net::Private::FDeltaCompressionBaselineManager::RemoveConnection

(

uint32

ConnectionId

)

SetDeltaCompressionStatus()

void UE::Net::Private::FDeltaCompressionBaselineManager::SetDeltaCompressionStatus	(	FInternalNetRefIndex	Index,
		ENetObjectDeltaCompressionStatus	Status
	)

---

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

• Engine/Source/Runtime/Net/Iris/Private/Iris/ReplicationSystem/DeltaCompression/DeltaCompressionBaselineManager.h
• Engine/Source/Runtime/Net/Iris/Private/Iris/ReplicationSystem/DeltaCompression/DeltaCompressionBaselineManager.cpp