UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::Net::FNetTokenStore Class Reference

#include <NetTokenStore.h>

Classes

struct  FInitParams
 

Public Member Functions

IRISCORE_API FNetTokenStore ()
 
IRISCORE_API ~FNetTokenStore ()
 
IRISCORE_API void Init (FInitParams &InitParams)
 
bool IsAuthority () const
 
bool IsLocalToken (const FNetToken NetToken) const
 
IRISCORE_API bool RegisterDataStore (TUniquePtr< FNetTokenDataStore > DataStore, FName TokenStoreName)
 
IRISCORE_API bool UnRegisterDataStore (FName TokenStoreName)
 
IRISCORE_API const FNetTokenDataStoreGetDataStore (FName Name) const
 
IRISCORE_API FNetTokenDataStoreGetDataStore (FName Name)
 
template<typename T >
bool CreateAndRegisterDataStore ()
 
template<typename T >
bool DeleteAndUnRegisterDataStore ()
 
template<typename T >
T * GetDataStore ()
 
template<typename T >
const T * GetDataStore () const
 
const FNetTokenStoreStateGetLocalNetTokenStoreState () const
 
FNetTokenStoreStateGetLocalNetTokenStoreState ()
 
IRISCORE_API void InitRemoteNetTokenStoreState (uint32 ConnectionId)
 
IRISCORE_API const FNetTokenStoreStateGetRemoteNetTokenStoreState (uint32 ConnectionId) const
 
IRISCORE_API FNetTokenStoreStateGetRemoteNetTokenStoreState (uint32 ConnectionId)
 
IRISCORE_API void WriteTokenData (FNetSerializationContext &Context, const FNetToken NetToken) const
 
IRISCORE_API void ReadTokenData (FNetSerializationContext &Context, const FNetToken NetToken, FNetTokenStoreState &RemoteNetTokenStoreState)
 
IRISCORE_API void WriteTokenData (FArchive &Ar, const FNetToken NetToken, UPackageMap *Map=nullptr) const
 
IRISCORE_API void ReadTokenData (FArchive &Ar, const FNetToken NetToken, FNetTokenStoreState &RemoteNetTokenStoreState, UPackageMap *Map=nullptr)
 
IRISCORE_API void ConditionalWriteNetTokenData (FNetSerializationContext &Context, Private::FNetExportContext *ExportContext, const FNetToken NetToken) const
 
IRISCORE_API void ConditionalReadNetTokenData (FNetSerializationContext &Context, const FNetToken NetToken)
 
template<typename T >
void WriteNetTokenWithKnownType (FNetSerializationContext &Context, FNetToken NetToken)
 
template<typename T >
FNetToken ReadNetTokenWithKnownType (FNetSerializationContext &Context)
 
void WriteNetToken (FNetSerializationContext &Context, FNetToken NetToken) const
 
FNetToken ReadNetToken (FNetSerializationContext &Context) const
 
void WriteNetToken (FArchive &Ar, FNetToken NetToken) const
 
FNetToken ReadNetToken (FArchive &Ar) const
 

Static Public Member Functions

static IRISCORE_API void AppendExport (FNetSerializationContext &, FNetToken NetToken)
 

Detailed Description

FNetTokenStore Main system for using NetTokensm currently owns type specific NetTokenDataStores and per connection state Currently we have a unique instance per NetDriver/ReplicationSystem but it is possible we will share this across game instance.

Constructor & Destructor Documentation

◆ FNetTokenStore()

UE::Net::FNetTokenStore::FNetTokenStore ( )

◆ ~FNetTokenStore()

UE::Net::FNetTokenStore::~FNetTokenStore ( )

Member Function Documentation

◆ AppendExport()

void UE::Net::FNetTokenStore::AppendExport ( FNetSerializationContext Context,
FNetToken  NetToken 
)
static

Utility methods, consolidate with other changes to NetTokenStore as next step.

◆ ConditionalReadNetTokenData()

void UE::Net::FNetTokenStore::ConditionalReadNetTokenData ( FNetSerializationContext Context,
const FNetToken  NetToken 
)

Conditionally read NetTokenData if exported.

◆ ConditionalWriteNetTokenData()

void UE::Net::FNetTokenStore::ConditionalWriteNetTokenData ( FNetSerializationContext Context,
Private::FNetExportContext ExportContext,
const FNetToken  NetToken 
) const

Conditionally write NetTokenData unless already exported.

◆ CreateAndRegisterDataStore()

template<typename T >
bool UE::Net::FNetTokenStore::CreateAndRegisterDataStore ( )
inline

Create and return data store of specified type, it will be owned by NetTokenStore.

◆ DeleteAndUnRegisterDataStore()

template<typename T >
bool UE::Net::FNetTokenStore::DeleteAndUnRegisterDataStore ( )
inline

Unregister a data store of specified type.

◆ GetDataStore() [1/4]

template<typename T >
T * UE::Net::FNetTokenStore::GetDataStore ( )
inline

Return data store of specified type.

◆ GetDataStore() [2/4]

template<typename T >
const T * UE::Net::FNetTokenStore::GetDataStore ( ) const
inline

Return data store of specified type.

◆ GetDataStore() [3/4]

FNetTokenDataStore * UE::Net::FNetTokenStore::GetDataStore ( FName  Name)

Get data store by name.

◆ GetDataStore() [4/4]

const FNetTokenDataStore * UE::Net::FNetTokenStore::GetDataStore ( FName  Name) const

Get const access to data store by name.

◆ GetLocalNetTokenStoreState() [1/2]

FNetTokenStoreState * UE::Net::FNetTokenStore::GetLocalNetTokenStoreState ( )
inline

Get access to the local NetTokenStoreState

◆ GetLocalNetTokenStoreState() [2/2]

const FNetTokenStoreState * UE::Net::FNetTokenStore::GetLocalNetTokenStoreState ( ) const
inline

Get const access to the local NetTokenStoreState

◆ GetRemoteNetTokenStoreState() [1/2]

FNetTokenStoreState * UE::Net::FNetTokenStore::GetRemoteNetTokenStoreState ( uint32  ConnectionId)

Get RemoteNetTokenStoreState for given ConnectionId.

◆ GetRemoteNetTokenStoreState() [2/2]

const FNetTokenStoreState * UE::Net::FNetTokenStore::GetRemoteNetTokenStoreState ( uint32  ConnectionId) const

Get const access to RemoteNetTokenStoreState for given ConnectionId.

◆ Init()

void UE::Net::FNetTokenStore::Init ( FNetTokenStore::FInitParams InParams)

◆ InitRemoteNetTokenStoreState()

void UE::Net::FNetTokenStore::InitRemoteNetTokenStoreState ( uint32  ConnectionId)

Init RemoteNetTokenStoreState for given ConnectionId, if it already exists it will be reset.

◆ IsAuthority()

bool UE::Net::FNetTokenStore::IsAuthority ( ) const
inline

Returns true if this is the authority, typically the server.

◆ IsLocalToken()

bool UE::Net::FNetTokenStore::IsLocalToken ( const FNetToken  NetToken) const
inline

A token is local if the authority of the NetTokenStore and the token matches, Invalid tokens are always local.

◆ ReadNetToken() [1/2]

FNetToken UE::Net::FNetTokenStore::ReadNetToken ( FArchive Ar) const
inline

Read NetToken including TypeId

◆ ReadNetToken() [2/2]

FNetToken UE::Net::FNetTokenStore::ReadNetToken ( FNetSerializationContext Context) const
inline

Read NetToken including TypeId

◆ ReadNetTokenWithKnownType()

template<typename T >
FNetToken UE::Net::FNetTokenStore::ReadNetTokenWithKnownType ( FNetSerializationContext Context)
inline

Convenience method to read a NetToken without reading type bits.

◆ ReadTokenData() [1/2]

void UE::Net::FNetTokenStore::ReadTokenData ( FArchive Ar,
const FNetToken  NetToken,
FNetTokenStoreState RemoteNetTokenStoreState,
UPackageMap Map = nullptr 
)

Read data associated with the NetToken. Do not export anything via the UPackageMap.

◆ ReadTokenData() [2/2]

void UE::Net::FNetTokenStore::ReadTokenData ( FNetSerializationContext Context,
const FNetToken  NetToken,
FNetTokenStoreState RemoteNetTokenStoreState 
)

Read data associated with the NetToken.

◆ RegisterDataStore()

bool UE::Net::FNetTokenStore::RegisterDataStore ( TUniquePtr< FNetTokenDataStore DataStore,
FName  TokenStoreName 
)

Register DataStore and return true if it was registered.

◆ UnRegisterDataStore()

bool UE::Net::FNetTokenStore::UnRegisterDataStore ( FName  TokenStoreName)

UnRegister a DataStore and return true if it was registered.

◆ WriteNetToken() [1/2]

void UE::Net::FNetTokenStore::WriteNetToken ( FArchive Ar,
FNetToken  NetToken 
) const
inline

Write NetToken including TypeId

◆ WriteNetToken() [2/2]

void UE::Net::FNetTokenStore::WriteNetToken ( FNetSerializationContext Context,
FNetToken  NetToken 
) const
inline

Write NetToken including TypeId

◆ WriteNetTokenWithKnownType()

template<typename T >
void UE::Net::FNetTokenStore::WriteNetTokenWithKnownType ( FNetSerializationContext Context,
FNetToken  NetToken 
)
inline

Convenience method to Write a NetToken without writing type bits In development builds it will verify that the token type matches the StoreType, otherwise it will skip the lookup of DataStore.

◆ WriteTokenData() [1/2]

void UE::Net::FNetTokenStore::WriteTokenData ( FArchive Ar,
const FNetToken  NetToken,
UPackageMap Map = nullptr 
) const

Write data associated with the NetToken. Do not export anything via the UPackageMap.

◆ WriteTokenData() [2/2]

void UE::Net::FNetTokenStore::WriteTokenData ( FNetSerializationContext Context,
const FNetToken  NetToken 
) const

Write data associated with the NetToken.


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