UE::Net::Private::FDormantReplicatorHolder Struct Reference

#include <NetDormantHolder.h>

Classes
struct	FActorDormantReplicatorsKeyFuncs

Public Types
typedef TSet< FActorDormantReplicators, FActorDormantReplicatorsKeyFuncs >	FActorReplicatorSet

Public Member Functions
bool	DoesReplicatorExist (AActor *DormantActor, UObject *ReplicatedObject) const
TSharedPtr< FObjectReplicator >	FindReplicator (AActor *DormantActor, UObject *ReplicatedObject)
TSharedPtr< FObjectReplicator >	FindAndRemoveReplicator (AActor *DormantActor, UObject *ReplicatedObject)
const TSharedRef< FObjectReplicator > &	CreateAndStoreReplicator (AActor *DormantActor, UObject *ReplicatedObject, bool &bOverwroteExistingReplicator)
void	StoreReplicator (AActor *DormantActor, UObject *ReplicatedObject, const TSharedRef< FObjectReplicator > &ObjectReplicator)
bool	RemoveStoredReplicator (AActor *DormantActor, FObjectKey ReplicatedObjectKey)
void	CleanupAllReplicatorsOfActor (AActor *DormantActor)
void	CleanupStaleObjects (FNetworkObjectList &NetworkObjectList, UObject *ReferenceOwner)
void	ForEachDormantReplicator (UE::Net::FExecuteForEachDormantReplicator Function)
void	ForEachDormantReplicatorOfActor (AActor *DormantActor, UE::Net::FExecuteForEachDormantReplicator Function)
void	EmptySet ()
void	CountBytes (FArchive &Ar) const
UE::Net::FDormantObjectMap *	FindFlushedObjectsForActor (AActor *Actor)
UE::Net::FDormantObjectMap &	FindOrAddFlushedObjectsForActor (AActor *Actor)
void	ClearFlushedObjectsForActor (AActor *Actor)

Public Attributes
FActorReplicatorSet	ActorReplicatorSet
TMap< FObjectKey, UE::Net::FDormantObjectMap >	FlushedObjectMap

Detailed Description

Container that stores the object replicators of dormant actors and their subobjects. Note that the actor stores it's own replicator and the replicators of it's subobjects

Member Typedef Documentation

FActorReplicatorSet

typedef TSet<FActorDormantReplicators, FActorDormantReplicatorsKeyFuncs> UE::Net::Private::FDormantReplicatorHolder::FActorReplicatorSet

Member Function Documentation

CleanupAllReplicatorsOfActor()

void UE::Net::Private::FDormantReplicatorHolder::CleanupAllReplicatorsOfActor

(

AActor *

DormantActor

)

Remove the references to all the object replicators tied to the given actor

Parameters

DormantActor

The dormant actor we want to clean any reference to

CleanupStaleObjects()

void UE::Net::Private::FDormantReplicatorHolder::CleanupStaleObjects	(	FNetworkObjectList &	NetworkObjectList,
		UObject *	ReferenceOwner
	)

Iterate over all the stored object replicators and destroy any that are tied to a replicated object that is now considered invalid. This version will decrement the subobject references stored in the networkobject list too.

Parameters

FNetworkObjectList	The netdriver's network object list
ReferenceOwner	The connection owner that is storing those dormant objects

ClearFlushedObjectsForActor()

void UE::Net::Private::FDormantReplicatorHolder::ClearFlushedObjectsForActor

(

AActor *

Actor

)

Clear stored flushed replicated sub-objects for a given actor, generally after replication or when the actor is destroyed

Parameters

Actor

The actor to clear the flushed object data for

CountBytes()

void UE::Net::Private::FDormantReplicatorHolder::CountBytes

(

FArchive &

Ar

)

const

CreateAndStoreReplicator()

const TSharedRef< FObjectReplicator > & UE::Net::Private::FDormantReplicatorHolder::CreateAndStoreReplicator	(	AActor *	DormantActor,
		UObject *	ReplicatedObject,
		bool &	bOverwroteExistingReplicator
	)

Create an object replicator for the given replicated object and store a reference to it. Does not initialize the Replicator but simply allocates it.

Parameters

DormantActor	The dormant actor that owns the replicated object
ReplicatedObject	The object that will be tied to the new ObjectReplicator.
bOverwroteExistingReplicator	When it returns true it means we erased an existing replicator.

Returns

Return a reference to the object replicator we created and are now storing.

DoesReplicatorExist()

bool UE::Net::Private::FDormantReplicatorHolder::DoesReplicatorExist	(	AActor *	DormantActor,
		UObject *	ReplicatedObject
	)		const

Are we currently storing an object replicator owned by the dormant actor.

Parameters

DormantActor	The dormant actor that owns the replicated object
ReplicatedObject	The object that was replicated and for whom we could be storing it's FObjectReplicator.

Returns

True if we are storing a replicator.

EmptySet()

void UE::Net::Private::FDormantReplicatorHolder::EmptySet

(

)

Remove every reference that is still stored.

FindAndRemoveReplicator()

TSharedPtr< FObjectReplicator > UE::Net::Private::FDormantReplicatorHolder::FindAndRemoveReplicator	(	AActor *	DormantActor,
		UObject *	ReplicatedObject
	)

Return the object replicator for the given replicated object but also remove the reference to that object replicator.

Parameters

DormantActor	The dormant actor that owns the replicated object
ReplicatedObject	The object that was replicated and for whom we want it's FObjectReplicator.

Returns

The object replicator of the replicated object if we were holding one. Otherwise an invalid pointer

FindFlushedObjectsForActor()

UE::Net::FDormantObjectMap * UE::Net::Private::FDormantReplicatorHolder::FindFlushedObjectsForActor

(

AActor *

Actor

)

Retrieve stored set of replicated sub-objects of the given actor at the time of the last dormancy flush This data is cleared when the actor is processed by ReplicateActor

Parameters

Actor

The actor to retrieve the object map for

Returns

A map of network guids to weak object pointers, or nullptr

FindOrAddFlushedObjectsForActor()

UE::Net::FDormantObjectMap & UE::Net::Private::FDormantReplicatorHolder::FindOrAddFlushedObjectsForActor

(

AActor *

Actor

)

Retrieve stored set of replicated sub-objects of the given actor at the time of the last dormancy flush This data is cleared when the actor is processed by ReplicateActor

Parameters

Actor

The actor to retrieve the object map for

Returns

A map of network guids to weak object pointers

FindReplicator()

TSharedPtr< FObjectReplicator > UE::Net::Private::FDormantReplicatorHolder::FindReplicator	(	AActor *	DormantActor,
		UObject *	ReplicatedObject
	)

Return the objector replicator for the given replicated object .

Parameters

DormantActor	The dormant actor that owns the replicated object.
ReplicatedObject	The object that was replicated

Returns

The object replicator of the replicated object if we were holding one. Otherwise an invalid pointer

ForEachDormantReplicator()

void UE::Net::Private::FDormantReplicatorHolder::ForEachDormantReplicator

(

UE::Net::FExecuteForEachDormantReplicator

Function

)

Execute the passed function on each dormant replicator we are holding

ForEachDormantReplicatorOfActor()

void UE::Net::Private::FDormantReplicatorHolder::ForEachDormantReplicatorOfActor	(	AActor *	DormantActor,
		UE::Net::FExecuteForEachDormantReplicator	Function
	)

Execute the passed function on each dormant replicatof owned by the given dormant actor

RemoveStoredReplicator()

bool UE::Net::Private::FDormantReplicatorHolder::RemoveStoredReplicator	(	AActor *	DormantActor,
		FObjectKey	ReplicatedObjectKey
	)

Remove our reference to the object replicator tied to the given replicated object

Parameters

DormantActor	The dormant actor that owns the replicated object
ReplicatedObjectKey	The object key to a replicated object that may have stored it's object replicator here

Returns

Return true if we did find the replicated object and removed it

StoreReplicator()

void UE::Net::Private::FDormantReplicatorHolder::StoreReplicator	(	AActor *	DormantActor,
		UObject *	ReplicatedObject,
		const TSharedRef< FObjectReplicator > &	ObjectReplicator
	)

Store an existing replicator tied to the given replicated object

Parameters

DormantActor	The dormant actor that owns the replicated object
ReplicatedObject	The object that is tied to the existing replicator
ObjectReplicator	The existing replicator we that will be stored

Member Data Documentation

ActorReplicatorSet

FActorReplicatorSet UE::Net::Private::FDormantReplicatorHolder::ActorReplicatorSet

The TSet indexed by Actor that stores all their dormant object replicators

FlushedObjectMap

TMap<FObjectKey, UE::Net::FDormantObjectMap> UE::Net::Private::FDormantReplicatorHolder::FlushedObjectMap

Map of actors to guid/weakptr pairs from the last dormancy flush

---

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

• Engine/Source/Runtime/Engine/Public/Net/NetDormantHolder.h
• Engine/Source/Runtime/Engine/Private/Net/NetDormantHolder.cpp