1. Epic GamesDeveloper
  3. FNetTokenStore

FNetTokenStore

[FNetTokenStore](API\Runtime\IrisCore\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.

API > API/Runtime > API/Runtime/IrisCore

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.

   
Name FNetTokenStore
Type class
Header File /Engine/Source/Runtime/Experimental/Iris/Core/Public/Iris/ReplicationSystem/NetTokenStore.h
Include Path #include "Iris/ReplicationSystem/NetTokenStore.h"

Syntax

class FNetTokenStore

Constructors

Name Remarks Include Path Unreal Specifiers
  Iris/ReplicationSystem/NetTokenStore.h  
  Iris/ReplicationSystem/NetTokenStore.h  
  Iris/ReplicationSystem/NetTokenStore.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FNetTokenStore()

   Iris/ReplicationSystem/NetTokenStore.h  

Structs

Name Remarks
FInitParams External configuration variables used to initialize the NetTokenStore

Typedefs

Name Type Remarks Include Path
FNetTokenStoreKey FNetTokenDataStore::FNetTokenStoreKey   Iris/ReplicationSystem/NetTokenStore.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
FNetTokenDataStore friend   Iris/ReplicationSystem/NetTokenStore.h  
LocalNetTokenStoreState TUniquePtr< FNetTokenStoreState >   Iris/ReplicationSystem/NetTokenStore.h  
Params FInitParams   Iris/ReplicationSystem/NetTokenStore.h  
RemoteNetTokenStoreStates TArray< TUniquePtr< FNetTokenStoreState > >   Iris/ReplicationSystem/NetTokenStore.h  
TokenDataStores TArray< TTuple< FName, TUniquePtr< FNetTokenDataStore > > >   Iris/ReplicationSystem/NetTokenStore.h  
UNetTokenDataStream friend   Iris/ReplicationSystem/NetTokenStore.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ConditionalReadNetTokenData ( FNetSerializationContext& Context,
const FNetToken NetToken
)

 Conditionally read NetTokenData if exported. Iris/ReplicationSystem/NetTokenStore.h  

void ConditionalWriteNetTokenData ( FNetSerializationContext& Context,
Private::FNetExportContext* ExportContext,
const FNetToken NetToken
) const

 Conditionally write NetTokenData unless already exported. Iris/ReplicationSystem/NetTokenStore.h  

bool CreateAndRegisterDataStore()

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

bool DeleteAndUnRegisterDataStore()

 Unregister a data store of specified type. Iris/ReplicationSystem/NetTokenStore.h  
Get data store by name. Iris/ReplicationSystem/NetTokenStore.h  

const FNetTokenDataStore * GetDataStore ( FName Name
) const

 Get const access to data store by name. Iris/ReplicationSystem/NetTokenStore.h  

const T * GetDataStore ()

 Return data store of specified type. Iris/ReplicationSystem/NetTokenStore.h  

T * GetDataStore ()

 Return data store of specified type. Iris/ReplicationSystem/NetTokenStore.h  

const FNetTokenStoreState * GetLocalNetTokenStoreState ()

 FNetTokenStoreState maps from NetTokenIndex -> NetTokenStoreKey (Index) Remote and local NetTokens use separate NetTokensStore states. Iris/ReplicationSystem/NetTokenStore.h  

FNetTokenStoreState * GetLocalNetTokenStoreState ()

 Get access to the local NetTokenStoreState Iris/ReplicationSystem/NetTokenStore.h  

const FNetTokenStoreState * GetRemoteNetTokenStoreState ( uint32 ConnectionId
) const

 Get const access to RemoteNetTokenStoreState for given ConnectionId. Iris/ReplicationSystem/NetTokenStore.h  

FNetTokenStoreState * GetRemoteNetTokenStoreState ( uint32 ConnectionId
)

 Get RemoteNetTokenStoreState for given ConnectionId. Iris/ReplicationSystem/NetTokenStore.h  

void Init ( FInitParams& InitParams
)

   Iris/ReplicationSystem/NetTokenStore.h  

void InitRemoteNetTokenStoreState ( uint32 ConnectionId
)

 Init RemoteNetTokenStoreState for given ConnectionId, if it already exists it will be reset. Iris/ReplicationSystem/NetTokenStore.h  

bool IsAuthority()

 Returns true if this is the authority, typically the server. Iris/ReplicationSystem/NetTokenStore.h  

bool IsLocalToken ( const FNetToken NetToken
) const

 A token is local if the authority of the NetTokenStore and the token matches, Invalid tokens are always local. Iris/ReplicationSystem/NetTokenStore.h  
Read NetToken including TypeId Iris/ReplicationSystem/NetTokenStore.h  
Read NetToken including TypeId Iris/ReplicationSystem/NetTokenStore.h  

FNetToken ReadNetTokenWithKnownType ( FNetSerializationContext& Context
)

 Convenience method to read a NetToken without reading type bits. Iris/ReplicationSystem/NetTokenStore.h  

void ReadTokenData ( FNetSerializationContext& Context,
const FNetToken NetToken,
FNetTokenStoreState& RemoteNetTokenStoreState
)

 Read data associated with the NetToken. Iris/ReplicationSystem/NetTokenStore.h  

void ReadTokenData ( FArchive& Ar,
const FNetToken NetToken,
FNetTokenStoreState& RemoteNetTokenStoreState,
UPackageMap* Map
)

 Read data associated with the NetToken. Iris/ReplicationSystem/NetTokenStore.h  

bool RegisterDataStore ( TUniquePtr< FNetTokenDataStore > DataStore,
FName TokenStoreName
)

 Register DataStore and return true if it was registered. Iris/ReplicationSystem/NetTokenStore.h  

bool UnRegisterDataStore ( FName TokenStoreName
)

 UnRegister a DataStore and return true if it was registered. Iris/ReplicationSystem/NetTokenStore.h  

void WriteNetToken ( FNetSerializationContext& Context,
FNetToken NetToken
) const

 Write NetToken including TypeId Iris/ReplicationSystem/NetTokenStore.h  

void WriteNetToken ( FArchive& Ar,
FNetToken NetToken
) const

 Write NetToken including TypeId Iris/ReplicationSystem/NetTokenStore.h  

void WriteNetTokenWithKnownType ( FNetSerializationContext& Context,
FNetToken NetToken
)

 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. Iris/ReplicationSystem/NetTokenStore.h  

void WriteTokenData ( FNetSerializationContext& Context,
const FNetToken NetToken
) const

 Write data associated with the NetToken. Iris/ReplicationSystem/NetTokenStore.h  

void WriteTokenData ( FArchive& Ar,
const FNetToken NetToken,
UPackageMap* Map
) const

 Write data associated with the NetToken. Iris/ReplicationSystem/NetTokenStore.h  

Static

Name Remarks Include Path Unreal Specifiers

static void AppendExport ( FNetSerializationContext&,
FNetToken NetToken
)

 Utility methods, consolidate with other changes to NetTokenStore as next step. Iris/ReplicationSystem/NetTokenStore.h  

static FNetToken InternalReadNetToken ( FArchive& Ar,
FNetToken::FTypeId TokenTypeId
)

   Iris/ReplicationSystem/NetTokenStore.h  

static FNetToken InternalReadNetToken ( UE::Net::FNetSerializationContext& Context,
FNetToken::FTypeId TokenTypeId
)

 Internal method to read a NetToken, if the TokenTypeId is valid it will be used instead of reading it from the bitstream. Iris/ReplicationSystem/NetTokenStore.h  

static void InternalWriteNetToken ( FArchive& Ar,
FNetToken Token,
bool bWriteTokenType
)

   Iris/ReplicationSystem/NetTokenStore.h  

static void InternalWriteNetToken ( UE::Net::FNetSerializationContext& Context,
FNetToken Token,
bool bWriteTokenType
)

 Internal method to write a NetToken, if bWriteTokenType is true it will write the TypeId as well. Iris/ReplicationSystem/NetTokenStore.h  

static FNetToken MakeNetToken ( uint32 TypeId,
uint32 Index,
FNetToken::ENetTokenAuthority Authority
)

   Iris/ReplicationSystem/NetTokenStore.h  

Operators

Name Remarks Include Path Unreal Specifiers
  Iris/ReplicationSystem/NetTokenStore.h  
  Iris/ReplicationSystem/NetTokenStore.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page