UE::Net::Private::FObjectPollFrequencyLimiter Class Reference

#include <ObjectPollFrequencyLimiter.h>

Public Member Functions
	FObjectPollFrequencyLimiter ()
void	Init (uint32 MaxActiveObjectCount)
void	Deinit ()
void	OnMaxInternalNetRefIndexIncreased (FInternalNetRefIndex NewMaxInternalIndex)
void	SetPollFramePeriod (FInternalNetRefIndex InternalIndex, uint8 PollFramePeriod)
void	SetPollWithObject (FInternalNetRefIndex ObjectToPollWithInternalIndex, FInternalNetRefIndex InternalIndex)
void	Update (const FNetBitArrayView &RelevantObjects, const FNetBitArrayView &DirtyObjects, FNetBitArrayView &OutObjectsToPoll)

Static Public Member Functions
static constexpr uint32	GetMaxPollingFrames ()

Constructor & Destructor Documentation

FObjectPollFrequencyLimiter()

UE::Net::Private::FObjectPollFrequencyLimiter::FObjectPollFrequencyLimiter

(

)

Member Function Documentation

Deinit()

void UE::Net::Private::FObjectPollFrequencyLimiter::Deinit

(

)

GetMaxPollingFrames()

static constexpr uint32 UE::Net::Private::FObjectPollFrequencyLimiter::GetMaxPollingFrames ( )

inlinestaticconstexpr

We use a uint8 to track frames, so the limit is 255 frames.

Init()

void UE::Net::Private::FObjectPollFrequencyLimiter::Init

(

uint32

MaxActiveObjectCount

)

OnMaxInternalNetRefIndexIncreased()

void UE::Net::Private::FObjectPollFrequencyLimiter::OnMaxInternalNetRefIndexIncreased

(

FInternalNetRefIndex

NewMaxInternalIndex

)

SetPollFramePeriod()

void UE::Net::Private::FObjectPollFrequencyLimiter::SetPollFramePeriod ( FInternalNetRefIndex  InternalIndex, uint8  PollFramePeriod  )

inline

SetPollWithObject()

void UE::Net::Private::FObjectPollFrequencyLimiter::SetPollWithObject ( FInternalNetRefIndex  ObjectToPollWithInternalIndex, FInternalNetRefIndex  InternalIndex  )

inline

Update()

void UE::Net::Private::FObjectPollFrequencyLimiter::Update	(	const FNetBitArrayView &	RelevantObjects,
		const FNetBitArrayView &	DirtyObjects,
		FNetBitArrayView &	OutObjectsToPoll
	)

Produces the list of objects that should be polled this frame. This list is composed of relevant objects that are dirty or that hit their poll period this frame.

---

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

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