Navigation
API > API/Runtime > API/Runtime/IrisCore
| Name | FNetSerializationContext |
| Type | class |
| Header File | /Engine/Source/Runtime/Net/Iris/Public/Iris/Serialization/NetSerializationContext.h |
| Include Path | #include "Iris/Serialization/NetSerializationContext.h" |
Syntax
class FNetSerializationContext
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Iris/Serialization/NetSerializationContext.h | |||
| Iris/Serialization/NetSerializationContext.h | |||
| Iris/Serialization/NetSerializationContext.h | |||
| Implementation. | Iris/Serialization/NetSerializationContext.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsInitializingDefaultState | uint32 | Set only when dealing with a default state. | Iris/Serialization/NetSerializationContext.h | |
| bIsInitState | uint32 | Set when replicated objects send their very first state. | Iris/Serialization/NetSerializationContext.h | |
| BitStreamReader | FNetBitStreamReader * | Iris/Serialization/NetSerializationContext.h | ||
| BitStreamWriter | FNetBitStreamWriter * | Iris/Serialization/NetSerializationContext.h | ||
| ChangeMask | const FNetBitArrayView * | Iris/Serialization/NetSerializationContext.h | ||
| ErrorContext | FNetErrorContext | Iris/Serialization/NetSerializationContext.h | ||
| ExportContext | Private::FNetExportContext * | Iris/Serialization/NetSerializationContext.h | ||
| InternalContext | Private::FInternalNetSerializationContext * | Iris/Serialization/NetSerializationContext.h | ||
| LocalConnectionId | uint32 | Iris/Serialization/NetSerializationContext.h | ||
| NetBlobReceiver | INetBlobReceiver * | Iris/Serialization/NetSerializationContext.h | ||
| NetStatsContext | Private::FNetStatsContext * | Iris/Serialization/NetSerializationContext.h | ||
| PacketId | int32 | Iris/Serialization/NetSerializationContext.h | ||
| ReadJournal | FNetJournal | Iris/Serialization/NetSerializationContext.h | ||
| TraceCollector | FNetTraceCollector * | Iris/Serialization/NetSerializationContext.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddReadJournalEntry
(
const TCHAR* Name |
Add entry into read journal, Name must be a static string as the pointer will be stored | Iris/Serialization/NetSerializationContext.h | |
void AddReadJournalEntry
(
const FNetDebugName* DebugName |
Add entry in to error context, Name must be a static string as the pointer will be stored | Iris/Serialization/NetSerializationContext.h | |
FNetBitStreamReader * GetBitStreamReader() |
Iris/Serialization/NetSerializationContext.h | ||
FNetBitStreamWriter * GetBitStreamWriter() |
Iris/Serialization/NetSerializationContext.h | ||
const FNetBitArrayView * GetChangeMask() |
Iris/Serialization/NetSerializationContext.h | ||
FName GetError() |
Iris/Serialization/NetSerializationContext.h | ||
const FNetRefHandle & GetErrorHandleContext() |
Iris/Serialization/NetSerializationContext.h | ||
Private::FNetExportContext * GetExportContext() |
Iris/Serialization/NetSerializationContext.h | ||
Private::FInternalNetSerializationContext * GetInternalContext() |
Iris/Serialization/NetSerializationContext.h | ||
uint32 GetLocalConnectionId() |
Iris/Serialization/NetSerializationContext.h | ||
UObject * GetLocalConnectionUserData
(
uint32 ConnectionId |
Retrieves the user data object associated with the local connection. | Iris/Serialization/NetSerializationContext.h | |
INetBlobReceiver * GetNetBlobReceiver() |
Iris/Serialization/NetSerializationContext.h | ||
Private::FNetStatsContext * GetNetStatsContext() |
Iris/Serialization/NetSerializationContext.h | ||
| Iris/Serialization/NetSerializationContext.h | |||
const UE::Net::FNetTokenStore * GetNetTokenStore () |
Iris/Serialization/NetSerializationContext.h | ||
int32 GetPacketId() |
Iris/Serialization/NetSerializationContext.h | ||
const UE::Net::FNetTokenStoreState * GetRemoteNetTokenStoreState() |
Iris/Serialization/NetSerializationContext.h | ||
FNetTraceCollector * GetTraceCollector() |
Iris/Serialization/NetSerializationContext.h | ||
bool HasError() |
Iris/Serialization/NetSerializationContext.h | ||
bool HasErrorOrOverflow() |
Iris/Serialization/NetSerializationContext.h | ||
bool IsInitializingDefaultState() |
Iris/Serialization/NetSerializationContext.h | ||
bool IsInitState() |
Iris/Serialization/NetSerializationContext.h | ||
| Iris/Serialization/NetSerializationContext.h | |||
| Iris/Serialization/NetSerializationContext.h | |||
FString PrintReadJournal() |
Print the ReadJournal | Iris/Serialization/NetSerializationContext.h | |
void ResetErrorContext() |
There are cases where an error is handled and reported where we want to stay calm, reset the error context and carry on | Iris/Serialization/NetSerializationContext.h | |
void ResetReadJournal() |
Iris/Serialization/NetSerializationContext.h | ||
void SetChangeMask
(
const FNetBitArrayView* InChangeMask |
If set, this is the changemask for the entire protocol. | Iris/Serialization/NetSerializationContext.h | |
void SetError
(
const FName Error, |
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 | Iris/Serialization/NetSerializationContext.h | |
void SetErrorHandleContext
(
const FNetRefHandle& HandleContext |
Store extra information regarding the object that triggered an error. | Iris/Serialization/NetSerializationContext.h | |
void SetExportContext
(
Private::FNetExportContext* InExportContext |
Iris/Serialization/NetSerializationContext.h | ||
void SetInternalContext
(
Private::FInternalNetSerializationContext* InInternalContext |
Iris/Serialization/NetSerializationContext.h | ||
void SetIsInitializingDefaultState
(
bool bInIsInitializingDefaultState |
Iris/Serialization/NetSerializationContext.h | ||
void SetIsInitState
(
bool bInIsInitState |
Iris/Serialization/NetSerializationContext.h | ||
void SetLocalConnectionId
(
uint32 InLocalConnectionId |
Iris/Serialization/NetSerializationContext.h | ||
void SetNetBlobReceiver
(
INetBlobReceiver* InNetBlobReceiver |
Iris/Serialization/NetSerializationContext.h | ||
void SetNetStatsContext
(
Private::FNetStatsContext* InNetStatsContext |
Iris/Serialization/NetSerializationContext.h | ||
void SetPacketId
(
int32 InPacketId |
Iris/Serialization/NetSerializationContext.h | ||
void SetTraceCollector
(
FNetTraceCollector* InTraceCollector |
Iris/Serialization/NetSerializationContext.h |