FNetTokenStore

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

References

   
Module IrisCore
Header /Engine/Source/Runtime/Experimental/Iris/Core/Public/Iris/ReplicationSystem/NetTokenStore.h
Include #include "Iris/ReplicationSystem/NetTokenStore.h"

Syntax

class FNetTokenStore

Remarks

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.

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Static void Utility methods, consolidate with other changes to NetTokenStore as next step.
Public function void Conditionally read NetTokenData if exported.
Public function Const void

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

 Conditionally write NetTokenData unless already exported.
Public function bool Create and return data store of specified type, it will be owned by NetTokenStore.
Public function FNetTokenDataStore *

GetDataStore ( FName Name
)

 Get data store by name.
Public function Const const FNetTokenDataStore *

GetDataStore ( FName Name
)

 Get const access to data store by name.
Public function T * Return data store of specified type.
Public function Const const T * Return data store of specified type.
Public function Const const FNetTokenStoreState * FNetTokenStoreState maps from NetTokenIndex -> NetTokenStoreKey (Index) Remote and local NetTokens use separate NetTokensStore states.
Public function FNetTokenStoreState * Get access to the local NetTokenStoreState
Public function Const const FNetTokenStoreState * Get const access to RemoteNetTokenStoreState for given ConnectionId.
Public function FNetTokenStoreState * Get RemoteNetTokenStoreState for given ConnectionId.
Public function void

Init ( FInitParams& InitParams
)

  
Public function void Init RemoteNetTokenStoreState for given ConnectionId, if it already exists it will be reset.
Public function Const bool Returns true if this is the authority, typically the server.
Public function Const bool

IsLocalToken ( const FNetToken NetToken
)

 A token is local if the authority of the NetTokenStore and the token matches, Invalid tokens are always local.
Public function Const FNetToken Read NetToken including TypeId
Public function Const FNetToken Read NetToken including TypeId
Public function FNetToken Convenience method to read a NetToken without reading type bits.
Public function void

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

 Read data associated with the NetToken.
Public function void

ReadTokenData ( FArchive& Ar,
const FNetToken NetToken,
FNetTokenStoreState& RemoteNetTokenStoreState
)

 Read data associated with the NetToken.
Public function bool

RegisterDataStore ( TUniquePtr< FNetTokenDataStore > DataStore,
FName TokenStoreName
)

 Register DataStore and return true if it was registered.
Public function Const void Write NetToken including TypeId
Public function Const void

WriteNetToken ( FArchive& Ar,
FNetToken NetToken
)

 Write NetToken including TypeId
Public function void 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.
Public function Const void

WriteTokenData ( FNetSerializationContext& Context,
const FNetToken NetToken
)

 Write data associated with the NetToken.
Public function Const void

WriteTokenData ( FArchive& Ar,
const FNetToken NetToken
)

 Write data associated with the NetToken.

Classes

  Type Name Description
Public struct FInitParams External configuration variables used to initialize the NetTokenStore  

Typedefs

Name Description
FNetTokenStoreKey  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page