UE::Net::FNetSerializerRegistryDelegates Class Reference

#include <NetSerializerDelegates.h>

Public Types
enum	EFlags : uint32 { None = 0U , ShouldBindLoadedModulesUpdatedDelegate = 1U }

Public Member Functions
IRISCORE_API	FNetSerializerRegistryDelegates ()
IRISCORE_API	FNetSerializerRegistryDelegates (EFlags Flags)
virtual IRISCORE_API	~FNetSerializerRegistryDelegates ()

Protected Member Functions
virtual IRISCORE_API void	OnPreFreezeNetSerializerRegistry ()
virtual IRISCORE_API void	OnPostFreezeNetSerializerRegistry ()
virtual IRISCORE_API void	OnLoadedModulesUpdated ()

Detailed Description

Helper class for registering NetSerializers. Override OnPreFreezeNetSerializerRegistry() to register your serializer and OnPostFreezeNetSerializerRegistry() to perform any additional fixup needed, such as creating a descriptor for a struct that you forward your NetSerializer's calls to. The virtual functions OnPreFreezeNetSerializerRegistry and OnPostFreezeNetSerializerRegistry will be called zero or one times each.

Member Enumeration Documentation

EFlags

enum UE::Net::FNetSerializerRegistryDelegates::EFlags : uint32

Enumerator
None
ShouldBindLoadedModulesUpdatedDelegate

Constructor & Destructor Documentation

FNetSerializerRegistryDelegates() [1/2]

UE::Net::FNetSerializerRegistryDelegates::FNetSerializerRegistryDelegates

(

)

FNetSerializerRegistryDelegates() [2/2]

UE::Net::FNetSerializerRegistryDelegates::FNetSerializerRegistryDelegates ( EFlags  Flags )

explicit

~FNetSerializerRegistryDelegates()

UE::Net::FNetSerializerRegistryDelegates::~FNetSerializerRegistryDelegates ( )

virtual

Implement a destructor to unregister your NetSerializers.

Member Function Documentation

OnLoadedModulesUpdated()

void UE::Net::FNetSerializerRegistryDelegates::OnLoadedModulesUpdated ( )

protectedvirtual

OnLoadedModulesUpdated delegate will be called every time a module has been loaded or unloaded It gives the serializer an opportunity to update cached data that could be affected by loading or unloading modules. NOTE: It will only be called if the EFlags::ShouldBindLoadedModulesUpdatedDelegate is set

OnPostFreezeNetSerializerRegistry()

void UE::Net::FNetSerializerRegistryDelegates::OnPostFreezeNetSerializerRegistry ( )

protectedvirtual

Post freeze is called after all loaded modules, including this one, has registered their serializers. At this point you should be able to get a descriptor for a struct that contains types that your module depends on.

OnPreFreezeNetSerializerRegistry()

void UE::Net::FNetSerializerRegistryDelegates::OnPreFreezeNetSerializerRegistry ( )

protectedvirtual

Pre freeze can be called before there are any serializers registered. At this point it's fine to register custom serializers for structs, but if you need a descriptor for a struct as a helper for your serializer you need to wait until post freeze.

---

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

• Engine/Source/Runtime/Net/Iris/Public/Iris/Serialization/NetSerializerDelegates.h
• Engine/Source/Runtime/Net/Iris/Private/Iris/Serialization/NetSerializerDelegates.cpp