UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
UE::Net::Private::FReplicationWriter Class Reference

#include <ReplicationWriter.h>

Classes

struct  FCannotSendInfo
 
struct  FReplicationInfo
 

Public Types

enum class  EReplicatedObjectState : uint8 {
  Invalid = 0 , AttachmentToObjectNotInScope , HugeObject , PendingCreate ,
  WaitOnCreateConfirmation , Created , WaitOnFlush , PendingTearOff ,
  SubObjectPendingDestroy , CancelPendingDestroy , PendingDestroy , WaitOnDestroyConfirmation ,
  Destroyed , PermanentlyDestroyed , Count
}
 
enum  EFlushFlags : uint32 {
  FlushFlags_None = 0U , FlushFlags_FlushState = 1U << 0U , FlushFlags_FlushReliable = FlushFlags_FlushState << 1U , FlushFlags_FlushTornOffSubObjects = FlushFlags_FlushReliable << 1U ,
  FlushFlags_All = FlushFlags_FlushState | FlushFlags_FlushReliable | FlushFlags_FlushTornOffSubObjects , FlushFlags_Default = FlushFlags_FlushReliable
}
 

Public Member Functions

 ~FReplicationWriter ()
 
void Init (const FReplicationParameters &InParameters)
 
void Deinit ()
 
void UpdateScope (const FNetBitArrayView &ScopedObjects)
 
void ForceUpdateDirtyChangeMasks (const FChangeMaskCache &CachedChangeMasks, EFlushFlags ExtraFlushFlags, bool bMarkForTearOff)
 
void NotifyDestroyedObjectPendingEndReplication (FInternalNetRefIndex ObjectInternalIndex)
 
void UpdateDirtyGlobalLifetimeConditionals (TArrayView< FInternalNetRefIndex > ObjectsWithDirtyConditionals)
 
void UpdateDirtyChangeMasks (const FChangeMaskCache &CachedChangeMasks)
 
const FNetBitArray & GetObjectsRequiringPriorityUpdate () const
 
void UpdatePriorities (const float *UpdatedPriorities)
 
UDataStream::EWriteResult BeginWrite (const UDataStream::FBeginWriteParameters &Params)
 
UDataStream::EWriteResult Write (FNetSerializationContext &Context)
 
void EndWrite ()
 
void ProcessDeliveryNotification (EPacketDeliveryStatus PacketDeliveryStatus)
 
void SetReplicationEnabled (bool bInReplicationEnabled)
 
bool IsReplicationEnabled () const
 
void SetNetExports (FNetExports &InNetExports)
 
bool QueueNetObjectAttachments (FInternalNetRefIndex OwnerInternalIndex, FInternalNetRefIndex SubObjectInternalIndex, TArrayView< const TRefCountPtr< FNetBlob > > Attachments, ENetObjectAttachmentSendPolicyFlags SendFlags)
 
bool AreAllReliableAttachmentsSentAndAcked () const
 
void Update (const UDataStream::FUpdateParameters &Params)
 
FString PrintObjectInfo (FInternalNetRefIndex ObjectIndex) const
 

Static Public Member Functions

static const TCHAR * LexToString (const EReplicatedObjectState State)
 

Static Public Attributes

static constexpr float CreatePriority = 1.f
 
static constexpr float TearOffPriority = 1.f
 
static constexpr float LostStatePriorityBump = 1.f
 
static constexpr float SchedulingThresholdPriority = 1.f
 
static const uint32 PartialSortObjectCount = 128u
 

Member Enumeration Documentation

◆ EFlushFlags

enum UE::Net::Private::FReplicationWriter::EFlushFlags : uint32
Enumerator
FlushFlags_None 
FlushFlags_FlushState 
FlushFlags_FlushReliable 
FlushFlags_FlushTornOffSubObjects 
FlushFlags_All 
FlushFlags_Default 

◆ EReplicatedObjectState

enum class UE::Net::Private::FReplicationWriter::EReplicatedObjectState : uint8
strong
Enumerator
Invalid 
AttachmentToObjectNotInScope 
HugeObject 
PendingCreate 
WaitOnCreateConfirmation 
Created 
WaitOnFlush 
PendingTearOff 
SubObjectPendingDestroy 
CancelPendingDestroy 
PendingDestroy 
WaitOnDestroyConfirmation 
Destroyed 
PermanentlyDestroyed 
Count 

Constructor & Destructor Documentation

◆ ~FReplicationWriter()

UE::Net::Private::FReplicationWriter::~FReplicationWriter ( )

Member Function Documentation

◆ AreAllReliableAttachmentsSentAndAcked()

bool UE::Net::Private::FReplicationWriter::AreAllReliableAttachmentsSentAndAcked ( ) const

◆ BeginWrite()

UDataStream::EWriteResult UE::Net::Private::FReplicationWriter::BeginWrite ( const UDataStream::FBeginWriteParameters &  Params)

◆ Deinit()

void UE::Net::Private::FReplicationWriter::Deinit ( )

◆ EndWrite()

void UE::Net::Private::FReplicationWriter::EndWrite ( )

◆ ForceUpdateDirtyChangeMasks()

void UE::Net::Private::FReplicationWriter::ForceUpdateDirtyChangeMasks ( const FChangeMaskCache &  CachedChangeMasks,
EFlushFlags  ExtraFlushFlags,
bool  bMarkForTearOff 
)
inline

◆ GetObjectsRequiringPriorityUpdate()

const FNetBitArray & UE::Net::Private::FReplicationWriter::GetObjectsRequiringPriorityUpdate ( ) const

◆ Init()

void UE::Net::Private::FReplicationWriter::Init ( const FReplicationParameters &  InParameters)

◆ IsReplicationEnabled()

bool UE::Net::Private::FReplicationWriter::IsReplicationEnabled ( ) const

◆ LexToString()

const TCHAR * UE::Net::Private::FReplicationWriter::LexToString ( const EReplicatedObjectState  State)
static

◆ NotifyDestroyedObjectPendingEndReplication()

void UE::Net::Private::FReplicationWriter::NotifyDestroyedObjectPendingEndReplication ( FInternalNetRefIndex  ObjectInternalIndex)

◆ PrintObjectInfo()

FString UE::Net::Private::FReplicationWriter::PrintObjectInfo ( FInternalNetRefIndex  ObjectIndex) const

◆ ProcessDeliveryNotification()

void UE::Net::Private::FReplicationWriter::ProcessDeliveryNotification ( EPacketDeliveryStatus  PacketDeliveryStatus)

◆ QueueNetObjectAttachments()

bool UE::Net::Private::FReplicationWriter::QueueNetObjectAttachments ( FInternalNetRefIndex  OwnerInternalIndex,
FInternalNetRefIndex  SubObjectInternalIndex,
TArrayView< const TRefCountPtr< FNetBlob > >  Attachments,
ENetObjectAttachmentSendPolicyFlags  SendFlags 
)

◆ SetNetExports()

void UE::Net::Private::FReplicationWriter::SetNetExports ( FNetExports &  InNetExports)

◆ SetReplicationEnabled()

void UE::Net::Private::FReplicationWriter::SetReplicationEnabled ( bool  bInReplicationEnabled)

◆ Update()

void UE::Net::Private::FReplicationWriter::Update ( const UDataStream::FUpdateParameters &  Params)

◆ UpdateDirtyChangeMasks()

void UE::Net::Private::FReplicationWriter::UpdateDirtyChangeMasks ( const FChangeMaskCache &  CachedChangeMasks)
inline

◆ UpdateDirtyGlobalLifetimeConditionals()

void UE::Net::Private::FReplicationWriter::UpdateDirtyGlobalLifetimeConditionals ( TArrayView< FInternalNetRefIndex >  ObjectsWithDirtyConditionals)

◆ UpdatePriorities()

void UE::Net::Private::FReplicationWriter::UpdatePriorities ( const float *  UpdatedPriorities)

◆ UpdateScope()

void UE::Net::Private::FReplicationWriter::UpdateScope ( const FNetBitArrayView &  ScopedObjects)

◆ Write()

UDataStream::EWriteResult UE::Net::Private::FReplicationWriter::Write ( FNetSerializationContext &  Context)

Member Data Documentation

◆ CreatePriority

constexpr float UE::Net::Private::FReplicationWriter::CreatePriority = 1.f
staticconstexpr

◆ LostStatePriorityBump

constexpr float UE::Net::Private::FReplicationWriter::LostStatePriorityBump = 1.f
staticconstexpr

◆ PartialSortObjectCount

const uint32 UE::Net::Private::FReplicationWriter::PartialSortObjectCount = 128u
static

◆ SchedulingThresholdPriority

constexpr float UE::Net::Private::FReplicationWriter::SchedulingThresholdPriority = 1.f
staticconstexpr

◆ TearOffPriority

constexpr float UE::Net::Private::FReplicationWriter::TearOffPriority = 1.f
staticconstexpr
The documentation for this class was generated from the following files: