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

#include <NetSerializationContext.h>

Public Member Functions

 FNetSerializationContext ()
 
 FNetSerializationContext (FNetBitStreamReader *, FNetBitStreamWriter *)
 
 FNetSerializationContext (FNetBitStreamReader *)
 
 FNetSerializationContext (FNetBitStreamWriter *)
 
FNetBitStreamReaderGetBitStreamReader ()
 
FNetBitStreamWriterGetBitStreamWriter ()
 
FNetSerializationContext MakeSubContext (FNetBitStreamWriter *) const
 
FNetSerializationContext MakeSubContext (FNetBitStreamReader *) const
 
void SetTraceCollector (FNetTraceCollector *InTraceCollector)
 
FNetTraceCollectorGetTraceCollector ()
 
bool HasError () const
 
bool HasErrorOrOverflow () const
 
void SetError (const FName Error, bool bDoOverFlow=true)
 
FName GetError () const
 
void SetErrorHandleContext (const FNetRefHandle &HandleContext)
 
const FNetRefHandleGetErrorHandleContext () const
 
void ResetErrorContext ()
 
void AddReadJournalEntry (const TCHAR *Name)
 
void AddReadJournalEntry (const FNetDebugName *DebugName)
 
FString PrintReadJournal ()
 
void ResetReadJournal ()
 
void SetIsInitState (bool bInIsInitState)
 
bool IsInitState () const
 
void SetChangeMask (const FNetBitArrayView *InChangeMask)
 
const FNetBitArrayViewGetChangeMask () const
 
INetBlobReceiverGetNetBlobReceiver ()
 
void SetNetBlobReceiver (INetBlobReceiver *InNetBlobReceiver)
 
void SetLocalConnectionId (uint32 InLocalConnectionId)
 
uint32 GetLocalConnectionId () const
 
IRISCORE_API UObjectGetLocalConnectionUserData (uint32 ConnectionId)
 
IRISCORE_API const UE::Net::FNetTokenStoreGetNetTokenStore () const
 
IRISCORE_API UE::Net::FNetTokenStoreGetNetTokenStore ()
 
IRISCORE_API const UE::Net::FNetTokenStoreStateGetRemoteNetTokenStoreState () const
 
void SetInternalContext (Private::FInternalNetSerializationContext *InInternalContext)
 
Private::FInternalNetSerializationContextGetInternalContext ()
 
void SetExportContext (Private::FNetExportContext *InExportContext)
 
Private::FNetExportContextGetExportContext ()
 
void SetNetStatsContext (Private::FNetStatsContext *InNetStatsContext)
 
Private::FNetStatsContextGetNetStatsContext ()
 
void SetIsInitializingDefaultState (bool bInIsInitializingDefaultState)
 
bool IsInitializingDefaultState () const
 
void SetPacketId (int32 InPacketId)
 
int32 GetPacketId () const
 

Constructor & Destructor Documentation

◆ FNetSerializationContext() [1/4]

UE::Net::FNetSerializationContext::FNetSerializationContext ( )
inline

◆ FNetSerializationContext() [2/4]

UE::Net::FNetSerializationContext::FNetSerializationContext ( FNetBitStreamReader InBitStreamReader,
FNetBitStreamWriter InBitStreamWriter 
)
inline

◆ FNetSerializationContext() [3/4]

UE::Net::FNetSerializationContext::FNetSerializationContext ( FNetBitStreamReader InBitStreamReader)
inlineexplicit

◆ FNetSerializationContext() [4/4]

UE::Net::FNetSerializationContext::FNetSerializationContext ( FNetBitStreamWriter InBitStreamWriter)
inlineexplicit

Member Function Documentation

◆ AddReadJournalEntry() [1/2]

void UE::Net::FNetSerializationContext::AddReadJournalEntry ( const FNetDebugName DebugName)

Add entry in to error context, Name must be a static string as the pointer will be stored

◆ AddReadJournalEntry() [2/2]

void UE::Net::FNetSerializationContext::AddReadJournalEntry ( const TCHAR Name)

Add entry into read journal, Name must be a static string as the pointer will be stored

◆ GetBitStreamReader()

FNetBitStreamReader * UE::Net::FNetSerializationContext::GetBitStreamReader ( )
inline

◆ GetBitStreamWriter()

FNetBitStreamWriter * UE::Net::FNetSerializationContext::GetBitStreamWriter ( )
inline

◆ GetChangeMask()

const FNetBitArrayView * UE::Net::FNetSerializationContext::GetChangeMask ( ) const
inline

◆ GetError()

FName UE::Net::FNetSerializationContext::GetError ( ) const
inline

◆ GetErrorHandleContext()

const FNetRefHandle & UE::Net::FNetSerializationContext::GetErrorHandleContext ( ) const
inline

◆ GetExportContext()

Private::FNetExportContext * UE::Net::FNetSerializationContext::GetExportContext ( )
inline

◆ GetInternalContext()

Private::FInternalNetSerializationContext * UE::Net::FNetSerializationContext::GetInternalContext ( )
inline

◆ GetLocalConnectionId()

uint32 UE::Net::FNetSerializationContext::GetLocalConnectionId ( ) const
inline

◆ GetLocalConnectionUserData()

UObject * UE::Net::FNetSerializationContext::GetLocalConnectionUserData ( uint32  ConnectionId)

Retrieves the user data object associated with the local connection.

Parameters
ConnectionIdLocal connection ID.
Returns
The user data object associated with the connection.

◆ GetNetBlobReceiver()

INetBlobReceiver * UE::Net::FNetSerializationContext::GetNetBlobReceiver ( )
inline

◆ GetNetStatsContext()

Private::FNetStatsContext * UE::Net::FNetSerializationContext::GetNetStatsContext ( )
inline

◆ GetNetTokenStore() [1/2]

FNetTokenStore * UE::Net::FNetSerializationContext::GetNetTokenStore ( )

◆ GetNetTokenStore() [2/2]

const FNetTokenStore * UE::Net::FNetSerializationContext::GetNetTokenStore ( ) const

◆ GetPacketId()

int32 UE::Net::FNetSerializationContext::GetPacketId ( ) const
inline

◆ GetRemoteNetTokenStoreState()

const UE::Net::FNetTokenStoreState * UE::Net::FNetSerializationContext::GetRemoteNetTokenStoreState ( ) const

◆ GetTraceCollector()

FNetTraceCollector * UE::Net::FNetSerializationContext::GetTraceCollector ( )
inline

◆ HasError()

bool UE::Net::FNetSerializationContext::HasError ( ) const
inline

◆ HasErrorOrOverflow()

bool UE::Net::FNetSerializationContext::HasErrorOrOverflow ( ) const
inline

◆ IsInitializingDefaultState()

bool UE::Net::FNetSerializationContext::IsInitializingDefaultState ( ) const
inline

◆ IsInitState()

bool UE::Net::FNetSerializationContext::IsInitState ( ) const
inline

◆ MakeSubContext() [1/2]

FNetSerializationContext UE::Net::FNetSerializationContext::MakeSubContext ( FNetBitStreamReader InBitStreamReader) const
inline

◆ MakeSubContext() [2/2]

FNetSerializationContext UE::Net::FNetSerializationContext::MakeSubContext ( FNetBitStreamWriter InBitStreamWriter) const
inline

◆ PrintReadJournal()

FString UE::Net::FNetSerializationContext::PrintReadJournal ( )

Print the ReadJournal

◆ ResetErrorContext()

void UE::Net::FNetSerializationContext::ResetErrorContext ( )
inline

There are cases where an error is handled and reported where we want to stay calm, reset the error context and carry on

◆ ResetReadJournal()

void UE::Net::FNetSerializationContext::ResetReadJournal ( )
inline

◆ SetChangeMask()

void UE::Net::FNetSerializationContext::SetChangeMask ( const FNetBitArrayView InChangeMask)
inline

◆ SetError()

void UE::Net::FNetSerializationContext::SetError ( const FName  Error,
bool  bDoOverFlow = true 
)
inline

If an error has already been set calling this function again will be a no-op, if bDoOverFlow is true, the function will also mark the current bitstream as overflown

◆ SetErrorHandleContext()

void UE::Net::FNetSerializationContext::SetErrorHandleContext ( const FNetRefHandle HandleContext)
inline

Store extra information regarding the object that triggered an error.

◆ SetExportContext()

void UE::Net::FNetSerializationContext::SetExportContext ( Private::FNetExportContext InExportContext)
inline

◆ SetInternalContext()

void UE::Net::FNetSerializationContext::SetInternalContext ( Private::FInternalNetSerializationContext InInternalContext)
inline

◆ SetIsInitializingDefaultState()

void UE::Net::FNetSerializationContext::SetIsInitializingDefaultState ( bool  bInIsInitializingDefaultState)
inline

◆ SetIsInitState()

void UE::Net::FNetSerializationContext::SetIsInitState ( bool  bInIsInitState)
inline

◆ SetLocalConnectionId()

void UE::Net::FNetSerializationContext::SetLocalConnectionId ( uint32  InLocalConnectionId)
inline

◆ SetNetBlobReceiver()

void UE::Net::FNetSerializationContext::SetNetBlobReceiver ( INetBlobReceiver InNetBlobReceiver)
inline

◆ SetNetStatsContext()

void UE::Net::FNetSerializationContext::SetNetStatsContext ( Private::FNetStatsContext InNetStatsContext)
inline

◆ SetPacketId()

void UE::Net::FNetSerializationContext::SetPacketId ( int32  InPacketId)
inline

◆ SetTraceCollector()

void UE::Net::FNetSerializationContext::SetTraceCollector ( FNetTraceCollector InTraceCollector)
inline

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