description: FNetBitArrayHelper::XorOp

code: template<typename WordOpFunctor> void Combine ( const [FNetBitArray](API\Runtime\NetCore\Net\Core\FNetBitArray) & Other, WordOpFunctor && WordOp )


description: Copy bits from other bit array. The other array must have the same bit count.

module: NetCore

code: void Copy ( const [FNetBitArray](API\Runtime\NetCore\Net\Core\FNetBitArray) & Other )


code: void Copy ( const [FNetBitArrayView](API\Runtime\NetCore\Net\Core\FNetBitArrayView) & Other )


description: Counts the number of set bits in this array in the provided range.

code: uint32 CountSetBits ( uint32 StartIndex, uint32 Count ) const


description: FNetBitArrayHelper::XorOp

code: template<typename WordOpFunctor1, typename WordOpFunctor2> void CombineMultiple ( WordOpFunctor1 && Op, const [FNetBitArray](API\Runtime\NetCore\Net\Core\FNetBitArray) & ArrayA, WordOpFunctor2 && Op2, const [FNetBitArray](API\Runtime\NetCore\Net\Core\FNetBitArray) & ArrayB )


description: Release all memory and set capacity to 0 bits

code: void Empty()


description: Find first set bit. Returns InvalidIndex if no zero bit was found

code: uint32 FindFirstOne() const


description: Find first set bit starting from StartIndex. Returns InvalidIndex if no set bit was found.

code: uint32 FindFirstOne ( uint32 StartIndex ) const


description: Find first zero bit. Returns InvalidIndex if no zero bit was found

code: uint32 FindFirstZero() const


description: Find first zero bit starting from StartIndex. Returns InvalidIndex if no zero bit was found.

code: uint32 FindFirstZero ( uint32 StartIndex ) const


description: Find last set bit. Returns InvalidIndex if no set bit was found.

code: uint32 FindLastOne() const


description: Find last zero bit. Returns InvalidIndex if no zero bit was found.

code: uint32 FindLastZero() const


description: Compare two BitArrays bit by bit and invoke FunctorA(BitIndex) for bits set only in array A and invoke FunctorB(BitIndex) for bits set only in array B.

code: template<typename T, typename V> static void ForAllExclusiveBits ( const [FNetBitArray](API\Runtime\NetCore\Net\Core\FNetBitArray) & A, const [FNetBitArray](API\Runtime\NetCore\Net\Core\FNetBitArray) & B, T && FunctorA, V && FunctorB )


description: Iterate over all set bits and invoke functor with signature void(uint32 BitIndex).

code: template<typename T> void ForAllSetBits ( T && Functor ) const


description: Iterate over all words and execute Functor, with signature void(uint32 BitIndex), for all set bits after executing WordOpFunctor

code: template<typename T, typename V> static void ForAllSetBits ( const [FNetBitArray](API\Runtime\NetCore\Net\Core\FNetBitArray) & A, const [FNetBitArray](API\Runtime\NetCore\Net\Core\FNetBitArray) & B, T && WordOpFunctor, V && Functor )


description: Returns a pointer to the internal storage.

code: const [StorageWordType](API\Runtime\NetCore\Net\Core\FNetBitArrayBase\StorageWordType) * GetData() const


description: Get the bit with the specified index

code: bool GetBit ( uint32 Index ) const


description: Returns the number of words in our storage

code: uint32 GetNumWords() const


description: Returns the number of bits

code: uint32 GetNumBits() const


description:
Retrieves set bits in the provided range and returns how many indices were written to OutIndices. If OutIndices is filled to its capacity the search for set bits will end. OutIndices may be modified beyond the returned count but within the capacity.
Number of indices OutIndices was populated with.

code: uint32 GetSetBitIndices ( uint32 StartIndex, uint32 Count, uint32 * OutIndices, uint32 OutIndicesCapacity ) const


description: Sets a new size and resets the array's contents.

code: void Init ( uint32 BitCount )


description: Initialize a bit array with another array.

code: void InitAndCopy ( const [FNetBitArray](API\Runtime\NetCore\Net\Core\FNetBitArray) & Source )


code: void InitAndCopy ( const [FNetBitArrayView](API\Runtime\NetCore\Net\Core\FNetBitArrayView) & Source )


description: Returns true if any bit is set in the bitset. Note: Padding bits in storage are expected to be zero.

code: bool IsAnyBitSet() const


description: Returns true if any bit is set in the specified range. The range will be clamped if needed. Note: Padding bits in storage are expected to be zero.

code: bool IsAnyBitSet ( uint32 StartIndex, uint32 Count ) const


description: Return if a specified bit is set or not

code: bool IsBitSet ( uint32 Index ) const


description: Returns true if no bit is set in the bitset. Note: Padding bits in storage are expected to be zero.

code: bool IsNoBitSet() const


description: Return true if equal including BitCount and padding bits

code: bool operator== ( const [FNetBitArray](API\Runtime\NetCore\Net\Core\FNetBitArray) & Other ) const


description: Clear all bits in the array.

code: void Reset()


description: FNetBitArrayHelper::XorOp

code: template<typename WordOpFunctor> void Set ( const [FNetBitArray](API\Runtime\NetCore\Net\Core\FNetBitArray) & First, WordOpFunctor && WordOp, const [FNetBitArray](API\Runtime\NetCore\Net\Core\FNetBitArray) & Second )


description: Set the bit with the specified index

code: void SetBit ( uint32 Index )


description: Sets all bits in the array, but clears padding bits.

code: void SetAllBits()


description: Set the bit with the specified index to bValue

code: void SetBits ( uint32 StartIndex, uint32 Count )


code: void SetBitValue ( uint32 Index, bool bValue )


description: Sets the number of bits to BitCount. If the array grows the new bits will be cleared. Existing bits will remain intact.

code: void SetNumBits ( uint32 BitCount )


description: Creates an empty NetBitArray.

code: FNetBitArray()


description: FNetBitArrayPrinterfor more print options


description: Creates an array with size BitCount bits.

code: FNetBitArray ( uint32 BitCount )


description: Construct NetBitArray with the given BitCount but doesn't zero the allocated memory. Useful when the entire bit array will be overwritten before being read.

code: FNetBitArray ( uint32 BitCountIn, const [ENoResetNoValidateType](API\Runtime\NetCore\Net\Core\FNetBitArrayBase\ENoResetNoValidateType) )


className: FNetBitArray

description: Simple bit array with internal storage. Has very little error checking as it is used in performance critical code.

code: class FNetBitArray : public [UE::Net::FNetBitArrayBase](API\Runtime\NetCore\Net\Core\FNetBitArrayBase)


code: static constexpr [StorageWordType](API\Runtime\NetCore\Net\Core\FNetBitArrayBase\StorageWordType) AndNotOp ( [StorageWordType](API\Runtime\NetCore\Net\Core\FNetBitArrayBase\StorageWordType) A, [StorageWordType](API\Runtime\NetCore\Net\Core\FNetBitArrayBase\StorageWordType) B )


description: Some WordOps that can be passed to Combine() and ForAllSetBits()

code: static constexpr [StorageWordType](API\Runtime\NetCore\Net\Core\FNetBitArrayBase\StorageWordType) AndOp ( [StorageWordType](API\Runtime\NetCore\Net\Core\FNetBitArrayBase\StorageWordType) A, [StorageWordType](API\Runtime\NetCore\Net\Core\FNetBitArrayBase\StorageWordType) B )


className: ENoResetNoValidateType

code: enum ENoResetNoValidateType { NoResetNoValidate, }


className: EResetOnInitType

code: enum EResetOnInitType { ResetOnInit, }


className: InvalidIndex

description: Returned from various methods to indicate failure.

code: static constexpr uint32 InvalidIndex = ~0U;


code: static constexpr [StorageWordType](API\Runtime\NetCore\Net\Core\FNetBitArrayBase\StorageWordType) OrOp ( [StorageWordType](API\Runtime\NetCore\Net\Core\FNetBitArrayBase\StorageWordType) A, [StorageWordType](API\Runtime\NetCore\Net\Core\FNetBitArrayBase\StorageWordType) B )


className: StorageWordType

code: typedef uint32 StorageWordType


code: static constexpr [StorageWordType](API\Runtime\NetCore\Net\Core\FNetBitArrayBase\StorageWordType) XorOp ( [StorageWordType](API\Runtime\NetCore\Net\Core\FNetBitArrayBase\StorageWordType) A, [StorageWordType](API\Runtime\NetCore\Net\Core\FNetBitArrayBase\StorageWordType) B )


className: WordBitCount

code: static constexpr uint32 WordBitCount = sizeof(StorageWordType)*8U;


className: FNetBitArrayBase

code: class FNetBitArrayBase


className: FNetBitArrayHelper

description: FNetBitArrayHelperImplementation helper

code: class FNetBitArrayHelper


description: Print the number of bits different between each array and the value of each word with different bits in them

code: template<class T, class U> static [FString](API\Runtime\Core\Containers\FString) PrintDeltaBits ( const T & BitArrayA, const U & BitArrayB )


code: static constexpr uint32 WordBitCount = sizeof(StorageWordType) * 8u;


description: Print the number of bits different between each array

code: template<class T, class U> static [FString](API\Runtime\Core\Containers\FString) PrintDeltaSummary ( const T & BitArrayA, const U & BitArrayB )


description: FNetBitArrayPrinterImplementation

code: template<class T> static [FString](API\Runtime\Core\Containers\FString) PrintSetSummary ( const T & BitArray )


description: Print the number of zero bits in the bitarray and the value of each word with zero bits in them

code: template<class T> static [FString](API\Runtime\Core\Containers\FString) PrintZeroBits ( const T & BitArray )


description: Print the number of set bits in the bitarray and the value of each word with set bits in them

code: template<class T> static [FString](API\Runtime\Core\Containers\FString) PrintSetBits ( const T & BitArray )


description: Print the number of zero bits int he bitarray

code: template<class T> static [FString](API\Runtime\Core\Containers\FString) PrintZeroSummary ( const T & BitArray )


className: FNetBitArrayPrinter

description: No destructors are accessible with public or protected access.

code: class FNetBitArrayPrinter


className: ERangeStart

code: enum ERangeStart { Begin, End, }


code: bool operator!= ( const [FNetBitArrayRangedForConstIterator](API\Runtime\NetCore\Net\Core\FNetBitArrayRangedForConstIterat-) & It ) const


description: Returns the bit index the iterator is pointing at.

code: uint32 operator*() const


description: FNetBitArrayRangedForConstIteratorImplementation

code: FNetBitArrayRangedForConstIterator()


code: FNetBitArrayRangedForConstIterator &40; const FNetBitArrayBase::StorageWordType &42; InData, uint32 BitCount, ERangeStart RangeStart &41;


className: FNetBitArrayRangedForConstIterator

description: FNetBitArrayRangedForConstIterator.


description: DO NOT USE DIRECTLY Range-based for loop support iterating over set bits and returning the index to the set bit.


description: NetBitArrayView implementation.

code: static constexpr uint32 CalculateRequiredWordCount ( uint32 BitCount )


description: Clear the bit with the specified index

code: void ClearBit ( uint32 Index ) const


description: Clear the bits in the specified range

code: void ClearBits ( uint32 StartIndex, uint32 Count )


description: FNetBitArrayHelper::XorOp

code: template<typename WordOpFunctor> void Combine ( const [FNetBitArrayView](API\Runtime\NetCore\Net\Core\FNetBitArrayView) & Other, WordOpFunctor && WordOp )


description: All padding bits will be set to zero

code: void ClearPaddingBits()


description: FNetBitArrayHelper::XorOp

code: template<typename WordOpFunctor1, typename WordOpFunctor2> void CombineMultiple ( WordOpFunctor1 && Op, const [FNetBitArrayView](API\Runtime\NetCore\Net\Core\FNetBitArrayView) & ArrayA, WordOpFunctor2 && Op2, const [FNetBitArrayView](API\Runtime\NetCore\Net\Core\FNetBitArrayView) & ArrayB )


description: Copy bits from other bit array. The other array must have the same bit count.

code: void Copy ( const [FNetBitArrayView](API\Runtime\NetCore\Net\Core\FNetBitArrayView) & Other )


code: void Copy ( const [FNetBitArray](API\Runtime\NetCore\Net\Core\FNetBitArray) & Other )


description: Counts the number of set bits in this array in the provided range.

code: uint32 CountSetBits ( uint32 StartIndex, uint32 Count ) const


description: Find first set bit. Returns InvalidIndex if no zero bit was found

code: uint32 FindFirstOne() const


description: Find first set bit starting from StartIndex. Returns InvalidIndex if no set bit was found.

code: uint32 FindFirstOne ( uint32 StartIndex ) const


description: Find first zero bit. Returns InvalidIndex if no zero bit was found

code: uint32 FindFirstZero() const


description: Find first zero bit starting from StartIndex. Returns InvalidIndex if no zero bit was found.

code: uint32 FindFirstZero ( uint32 StartIndex ) const


description: Find last set bit. Returns InvalidIndex if no set bit was found.

code: uint32 FindLastOne() const


description: Find last zero bit. Returns InvalidIndex if no zero bit was found.

code: uint32 FindLastZero() const


description: Compare two BitArrays bit by bit and invoke FunctorA(BitIndex) for bits set only in array A and invoke FunctorB(BitIndex) for bits set only in array B.

code: template<typename T, typename V> static void ForAllExclusiveBits ( const [FNetBitArrayView](API\Runtime\NetCore\Net\Core\FNetBitArrayView) & A, const [FNetBitArrayView](API\Runtime\NetCore\Net\Core\FNetBitArrayView) & B, T && FunctorA, V && FunctorB )


description: Iterate over all set bits and invoke functor with signature void(uint32 BitIndex).

code: template<typename T> void ForAllSetBits ( T && Functor ) const


description: Iterate over all words and execute Functor, with signature void(uint32 BitIndex), for all set bits after executing WordOpFunctor

code: template<typename T, typename V> static void ForAllSetBits ( const [FNetBitArrayView](API\Runtime\NetCore\Net\Core\FNetBitArrayView) & A, const [FNetBitArrayView](API\Runtime\NetCore\Net\Core\FNetBitArrayView) & B, T && WordOpFunctor, V && Functor )


description: Get the bit with the specified index

code: bool GetBit ( uint32 Index ) const


description: Returns a pointer to the internal storage.


code: const [StorageWordType](API\Runtime\NetCore\Net\Core\FNetBitArrayBase\StorageWordType) * GetData() const


description: Returns the number of bits

code: uint32 GetNumBits() const


description: Returns the number of words in our storage

code: uint32 GetNumWords() const


description:
Retrieves set bits in the provided range and returns how many indices were written to OutIndices. If OutIndices is filled to its capacity the search for set bits will end. OutIndices may be modified beyond the returned count but within the capacity.
Number of indices OutIndices was populated with.

code: uint32 GetSetBitIndices ( uint32 StartIndex, uint32 Count, uint32 * OutIndices, uint32 OutIndicesCapacity ) const


description: Returns true if any bit is set in the bitset Note: Padding bits in storage are expected to be zero.

code: bool IsAnyBitSet() const


description: Returns true if any bit is set in the specified range. The range will be clamped if needed. Note: Padding bits in storage are expected to be zero.

code: bool IsAnyBitSet ( uint32 StartIndex, uint32 Count ) const


description: Return if a specified bit is set or not

code: bool IsBitSet ( uint32 Index ) const


description: Return true if equal including BitCount and padding bits

code: bool operator== ( const [FNetBitArrayView](API\Runtime\NetCore\Net\Core\FNetBitArrayView) & Other ) const


description: Returns true if no bit is set in the bitset. Note: Padding bits in storage are expected to be zero.

code: bool IsNoBitSet() const


description: Reset the storage of the BitArray including any padding bits

code: void Reset()


description: FNetBitArrayHelper::XorOp

code: template<typename WordOpFunctor> void Set ( const [FNetBitArrayView](API\Runtime\NetCore\Net\Core\FNetBitArrayView) & First, WordOpFunctor && WordOp, const [FNetBitArrayView](API\Runtime\NetCore\Net\Core\FNetBitArrayView) & Second )


description: Set all bits, padding bits will be zeroed

code: void SetAllBits()


description: Set the bit with the specified index

code: void SetBit ( uint32 Index )


description: Set the bits in the specified range to true

code: void SetBits ( uint32 StartIndex, uint32 Count )


description: Constructor will produce a valid but empty bitarray.

code: FNetBitArrayView()


description: FNetBitArrayPrinterfor more print options


description: Set the bit with the specified index to bValue

code: void SetBitValue ( uint32 Index, bool bValue )


description: Construct NetBitArray from external storage. Storage must be large enough to fit given the BitCount. Validates that padding bits are cleared.

code: FNetBitArrayView ( [StorageWordType](API\Runtime\NetCore\Net\Core\FNetBitArrayBase\StorageWordType) * StorageIn, uint32 BitCountIn )


description: Construct NetBitArray from external storage. Storage must be large enough to fit given the BitCount. Clears the entire storage.

code: FNetBitArrayView ( [StorageWordType](API\Runtime\NetCore\Net\Core\FNetBitArrayBase\StorageWordType) * StorageIn, uint32 BitCountIn, const [EResetOnInitType](API\Runtime\NetCore\Net\Core\FNetBitArrayBase\EResetOnInitType) )


description: Construct NetBitArray from external storage. Storage must be large enough to fit given the BitCount. No clearing of storage and no validation that padding bits are cleared.

code: FNetBitArrayView ( [StorageWordType](API\Runtime\NetCore\Net\Core\FNetBitArrayBase\StorageWordType) * StorageIn, uint32 BitCountIn, const [ENoResetNoValidateType](API\Runtime\NetCore\Net\Core\FNetBitArrayBase\ENoResetNoValidateType) )


className: FNetBitArrayView

description: Simple bit array view. Assumes external storage and has very little error checking as it is used in performance critical code. Note: Trailing padding bits in storage will be zeroed unless the view is explicitly constructed to allow it. Certain operations assume the padding bits are cleared.

code: class FNetBitArrayView : public [UE::Net::FNetBitArrayBase](API\Runtime\NetCore\Net\Core\FNetBitArrayBase)


description:
Performs periodic checks on NetConnection packet limits
Whether or not NetColnnection packet limits have been reached

code: bool CheckNetConnLimits()


description: Accessor for bDDoSLogRestrictions - doubles as a per-frame logspam counter, automatically disabling logs after a quota

code: bool CheckLogRestrictions()


description:
Performs periodic checks on trigger quota's and packet limits, for non-NetConnection packets
Whether or not non-NetConnection packet limits have been reached

code: bool CheckNonConnQuotasAndLimits()


description: Rate limited call to CheckNetConnLimits

code: void CondCheckNetConnLimits()


description: Rate limited call to CheckNonConnQuotasAndLimits

code: void CondCheckNonConnQuotasAndLimits()


code: int32 GetDroppedPacketCounter() const


code: int32 GetDisconnPacketCounter() const


code: int32 GetBadPacketCounter() const


code: int32 GetNetConnPacketCounter() const


code: int32 GetNonConnPacketCounter() const


code: int32 GetErrorPacketCounter() const


code: void IncDroppedPacketCounter ( int32 Count )


description: Initializes the DDoS detection settings

code: void Init ( int32 MaxTickRate )


description: Initializes the settings from the .ini file - must support reloading of settings on-the-fly

code: void InitConfig()


code: bool IsDDoSAnalyticsEnabled() const


code: bool IsDDoSDetectionEnabled() const


description: Triggered after packet receive ends, during the current frame

code: void PostFrameReceive()


description: Triggered before packet receive begins, during the current frame

code: void PreFrameReceive ( float DeltaTime )


description: Initialize the expected tick rate.

code: void SetMaxTickRate ( int32 MaxTickRate )


code: bool ShouldBlockNetConnPackets() const


code: bool ShouldBlockNonConnPackets() const


description: Blocking new connections: If a DDoS is expensive enough, that you choose to drop non-NetConnection packets after a threshold (a wise move, for performance...), then new players will be blocked from entering the server.FDDoSDetection

code: FDDoSDetection()


description: Updates the current DDoS detection severity state

code: void UpdateSeverity ( bool bEscalate )


className: FDDoSDetection

description: The main DDoS detection tracking class, for counting packets and applying restrictions. Implemented separate to the NetDriver, to allow wider use e.g. potentially at socket level, if useful.

code: class FDDoSDetection : protected [FDDoSPacketCounters](API\Runtime\NetCore\Net\Core\Misc\FDDoSPacketCounters), protected [FDDoSState](API\Runtime\NetCore\Net\Core\Misc\FDDoSState)

ActiveState

description: The currently active DDoS severity state settings

bDDoSAnalytics

type: bool

description: Whether or not analytics for DDoS detection is enabled

bDDoSDetection

description: Whether or not DDoS detection is presently enabled

bDDoSLogRestrictions

description: Whether or not restriction of log messages from non-NetConnection packets is enabled

bHitFrameNetConnLimit

description: Whether or not the current frame has reached NetConnection packet limits, and should block ALL further packets

bHitFrameNonConnLimit

description: Whether or not the current frame has reached non-NetConnection packet limits, and should block non-NetConnection packets

bMetEscalationConditionsThisFrame

description: Limit checking previous states escalation conditions to once per frame

CounterPerSecHistory

type: TArray<FDDoSPa...

description: Stores enough per second quota history, to allow all DetectionSeverity states to recalculate if their CooloffTime is reached

DDoSLogSpamLimit

description: The maximum number of non-NetConnection triggered log messages per frame, before further logs are dropped this frame

DetectionSeverity

type: TArray<FDDoSSt...

description: The different DDoS detection states, of escalating severity, depending on the strength of the DDoS

EndFrameRecvTimestamp

type: double

description: Timestamp for the end of the last frames receive loop

ExpectedFrameTime

description: The expected time between frames (1.0 / MaxTickRate) - used for adjusting limits/quota's based on DeltaTime

FrameAdjustment

type: float

description: The current frames adjustment/deviation, from ExpectedFrameTime

HitchFrameCount

description: The number of consecutive frames spent hitching

HitchFrameTolerance

description: The number of frames spent hitching, before disabling false positive detection, and treating packet buildup as potential DDoS

HitchTimeQuotaMS

description: The amount of time since the previous frame, for detecting frame hitches, to prevent DDoS detection false positives

LastCounterPerSecHistoryIdx

description: The last written index of CounterPerSecHistory

LastMetEscalationConditions

description: The last time the previous severity states escalation conditions were met (to prevent bouncing up/down between states)

LastPerSecQuotaBegin

description: Timestamp for the last time per-second quota counting began

LogHitCounter

description: Counter for log restriction hits, in the current frame

NotifySeverityEscalation

type: FDDoSSeverityEs...

description: Analytics delegate for notifying of severity state escalations

StartFramePacketCount

description: Counts the packets from the start of the current frame

StartFrameRecvTimestamp

description: The timestamp for the start of the current frames receive

WorstActiveState

description: The worst DDoS severity state that has been active - used for limiting analytics events


description:
Whether or not the specified counters and time passed has hit any of the quota's
Whether or not the quota was hit

code: bool HasHitQuota ( [FDDoSPacketCounters](API\Runtime\NetCore\Net\Core\Misc\FDDoSPacketCounters) & InCounter, int32 TimePassedMS ) const


className: FDDoSPacketCounters

description: Struct containing the per-second packet counters

code: struct FDDoSPacketCounters

BadPacketCounter

description: Counter for bad non-NetConnection packets received, since the last per second quota period began

DisconnPacketCounter

description: Counter for recently-disconnected NetConnection packets received, since the last per second quota period beegan

DroppedPacketCounter

description: Counter for the number of packets (of any type) dropped, since the last per second quota period began

ErrorPacketCounter

description: Counter for non-DDoS packet errors received

NetConnPacketCounter

description: Counter for NetConnection packets received, since the last per second quota period began

NonConnPacketCounter

description: Counter for non-NetConnection packets received, since the last per second quota period began

WorstFrameReceiveTimeMS

description: The worst per-frame packet receive time in milliseconds, over the ~1 second this packet counter history represents


code: void ApplyState ( [FDDoSState](API\Runtime\NetCore\Net\Core\Misc\FDDoSState) & Target )


className: FDDoSState

description: Stores the DDoS detection state (either settings from the config file, or the active DDoS detection state)

code: struct FDDoSState

bSendEscalateAnalytics

description: Whether or not to send analytics when escalating to this state

CooloffTime

description: The amount of time, in seconds, before the current DDoS severity category cools off and de-escalates

EscalateQuotaBadPacketsPerSec

description: The number of bad (failed to process correctly) packets/sec, before the next stage of DDoS detection is triggered

EscalateQuotaDisconnPacketsPerSec

description: The number of recently disconnected NetConnection packets/sec, before the next stage of DDoS detection is triggered.

EscalateQuotaPacketsPerSec

description: The number of packets/sec before the next stage of DDoS detection is triggered

EscalateTimeQuotaMSPerFrame

description: The amount of time spent processing packets, before the next stage of DDoS detection is triggered

NetConnPacketTimeLimitMSPerFrame

description: The limit for time spent processing NetConnection packets, each frame (counts all packets time, non-NetConn and NetConn)

PacketLimitPerFrame

description: The limit for the number of non-NetConnection packets to process, each frame

PacketTimeLimitMSPerFrame

description: The limit for time spent processing non-NetConnection packets, each frame (counts all packets time, non-NetConn and NetConn)


description: Applies only the per-frame adjusted state (based on expected vs actual framerate), to active DDoS protection. ApplyState should be called, first.

code: void ApplyAdjustedState ( [FDDoSState](API\Runtime\NetCore\Net\Core\Misc\FDDoSState) & Target, float FrameAdjustment )


className: FDDoSStateConfig

description: DDoS detection state, with functions for applying the state to active DDoS detection

code: struct FDDoSStateConfig : public [FDDoSState](API\Runtime\NetCore\Net\Core\Misc\FDDoSState)

SeverityCategory

type: FString

description: The name of the DDoS severity level this config section represents


code: void CountBytes ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar ) const


code: [FGuidReferences](API\Runtime\NetCore\Net\Core\Misc\FGuidReferences) & operator= ( const [FGuidReferences](API\Runtime\NetCore\Net\Core\Misc\FGuidReferences) & Other )


code: FGuidReferences ( const [FGuidReferences](API\Runtime\NetCore\Net\Core\Misc\FGuidReferences) & Other )


code: FGuidReferences ( FGuidReferencesMap * InArray, const int32 InParentIndex, const int32 InCmdIndex )


code: FGuidReferences ( [FBitReader](API\Runtime\Core\Serialization\FBitReader) & InReader, [FBitReaderMark](API\Runtime\Core\Serialization\FBitReaderMark) & InMark, const [TSet](API\Runtime\Core\Containers\TSet)< [FNetworkGUID](API\Runtime\Core\Misc\FNetworkGUID) > & InUnmappedGUIDs, const [TSet](API\Runtime\Core\Containers\TSet)< [FNetworkGUID](API\Runtime\Core\Misc\FNetworkGUID) > & InMappedDynamicGUIDs, const int32 InParentIndex, const int32 InCmdIndex )


className: FGuidReferences

description: Guid References may also be nested in properties (like dynamic arrays), so we'll recursively track those as well.

code: class FGuidReferences

Array

type: FGuidReferences...

description: If thisFGuidReferencesinstance is owned by an Array Property that contains nested GUID References, then this will be a valid FGuidReferencesMap containing the nestedFGuidReferences.

Buffer

type: TArray< uint8 >

description: A copy of the last network data read related to this GUID Reference.

CmdIndex

description: The Property Command index of the actual property that references the GUID.

MappedDynamicGUIDs

type: TSet<FNetworkG...

description: GUIDs for dynamically spawned objects that have already been created.

ParentIndex

description: The Property Command index of the top level property that references the GUID.

UnmappedGUIDs

description: GUIDs for objects that haven't been loaded / created yet.


description: Add a subobject into a netcondition group

code: void RegisterSubObjectInGroup ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * SubObject, [FName](API\Runtime\Core\UObject\FName) NetConditionGroup )


description: Add a subobject to many netcondition groups

code: void RegisterSubObjectInMultipleGroups ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * SubObject, [TArrayView](API\Runtime\Core\Containers\TArrayView)< [FName](API\Runtime\Core\UObject\FName) > NetConditionGroups )


description: Remove a subobject from a netcondition group

code: void UnregisterSubObjectFromGroup ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * SubObject, [FName](API\Runtime\Core\UObject\FName) NetConditionGroup )


description: Remove a subobject from many netcondition groups

code: void UnregisterSubObjectFromMultipleGroups ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * SubObject, [TArrayView](API\Runtime\Core\Containers\TArrayView)< [FName](API\Runtime\Core\UObject\FName) > NetConditionGroups )


description: Remove the subobject from all groups it was included into

code: void UnregisterSubObjectFromAllGroups ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * SubObject )


className: FNetConditionGroupManager

description: Groups are inclusive and non-binding so subobject's can be part of multiple groups at the same time. As long as a player is a member of one of the subobject's group, that subobject will be replicated to that connection.

code: class FNetConditionGroupManager


className: bIsInRPCStack

code: static bool bIsInRPCStack = false;


description: Tells true if we are inside code executed from a remote RPC. Will be false if the RPC is executed locally.

code: static bool IsInsideNetRPC()


className: FNetContext

description: No destructors are accessible with public or protected access.

code: class FNetContext


description: Return the groups the subobject is a part of. Will be empty if it wasn't added to any.

code: [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FName](API\Runtime\Core\UObject\FName) > GetSubObjectNetConditionGroups ( [FObjectKey](API\Runtime\CoreUObject\UObject\FObjectKey) SubObjectKey ) const


description: On the send side, marks a named stage during packet writing, which should be audited on the receive side.

code: static void AddStage ( [FString](API\Runtime\Core\Containers\FString) StageName, [FBitWriter](API\Runtime\Core\Serialization\FBitWriter) & OutPacket, bool bByteAligned )


description: On the receive side, checks to see that a named stage was marked for auditing on the send side, and audits the packet data.

code: static void CheckStage ( [FString](API\Runtime\Core\Containers\FString) StageName, [FBitReader](API\Runtime\Core\Serialization\FBitReader) & InPacket, bool bByteAligned )


code: void CheckStage_Internal ( [FString](API\Runtime\Core\Containers\FString) StageName, [FBitReader](API\Runtime\Core\Serialization\FBitReader) & InPacket, bool bByteAligned )


description: Destroy GPacketAuditor

code: static void Destruct()


description: Dumps the collected packet audit data to the log

code: void DumpAuditData ( [FScopedAuditAccess](API\Runtime\NetCore\Net\Core\Misc\FPacketAudit\FScopedAuditAccess) & AuditLock, uint32 InPacketCRC )


code: FScopedAuditAccess &40; FPacketAudit & InAudtor &41;


code: void AddStage_Internal ( [FString](API\Runtime\Core\Containers\FString) StageName, [FBitWriter](API\Runtime\Core\Serialization\FBitWriter) & OutPacket, bool bByteAligned )


className: FScopedAuditAccess

description: Provides scoped exclusive access to GSendPacketAudits and GReceivePacketAudits within the .cpp file

code: struct FScopedAuditAccess


description: Initialize GPacketAudtor

code: static void Init()


description: Low level netcode hook, notifying of incoming packets

code: static void NotifyLowLevelReceive ( [FBitReader](API\Runtime\Core\Serialization\FBitReader) & InPacket )


code: static void NotifyLowLevelReceive ( uint8 * Data, uint32 DataLen )


code: void NotifyLowLevelReceive_Internal ( [FBitReader](API\Runtime\Core\Serialization\FBitReader) & InPacket )


description: Low level netcode hook, notifying of outgoing packets

code: static void NotifyLowLevelSend ( [FBitWriter](API\Runtime\Core\Serialization\FBitWriter) & OutPacket )


code: static void NotifyLowLevelSend ( uint8 * Data, uint32 DataLen, uint32 DataLenBits )


code: void NotifyLowLevelSend_Internal ( [FBitWriter](API\Runtime\Core\Serialization\FBitWriter) & OutPacket )


description:
Gets the CRC of a packet, zeroing any unwritten bits in the last byte beforehand.
Returns the CRC of the packet

code: static uint32 PacketCRC ( uint8 * Data, uint32 DataLenBits )


className: FPacketAudit

code: class FPacketAudit

GameMutex

type: FPlatformProces...

description: Mutex used for enforcing a single instance of client/server packet auditing

ReceiveSharedMemory

type: FPlatformMemory...

description: Shared memory region for packet receives

SendSharedMemory

description: Shared memory region for packet sends

SharedMutex

description: Mutex used for exclusive access to shared memory


code: bool operator== ( const [FReplicatedComponentInfo](API\Runtime\NetCore\Net\Core\Misc\FReplicatedComponentInfo) & rhs ) const


code: bool operator== ( const [UActorComponent](API\Runtime\Engine\Components\UActorComponent) * rhs ) const


code: FReplicatedComponentInfo ( [UActorComponent](API\Runtime\Engine\Components\UActorComponent) * InComponent, ELifetimeCondition InNetCondition )


className: FReplicatedComponentInfo

description: Keep track of replicated components and their subobject list

code: struct FReplicatedComponentInfo

Component

type: UActorComponent...

description: Component that will be replicated

Key

type: FObjectKey

description: Store the object key info for fast access later

NetCondition

type: ELifetimeCondit...

description: NetCondition of the component

SubObjects

type: FSubObjectRegis...

description: Collection of subobjects replicated with this component


className: FScopedNetContextRPC

code: class FScopedNetContextRPC


description: Adds a subobject and returns if it's a new entry or existing entry

code: [FSubObjectRegistry::EResult](API\Runtime\NetCore\Net\Core\Misc\FSubObjectRegistry\EResult) AddSubObjectUnique ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * InSubObject, ELifetimeCondition InNetCondition )


description: Remove all the indexes specified by the passed array

code: void CleanRegistryIndexes ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< int32 > & IndexesToClean )


className: EResult

code: enum EResult { NewEntry, AlreadyRegistered, NetConditionConflict, }


code: UObject &42; GetSubObject&40;&41; const


code: bool operator&61;&61; &40; const FEntry & rhs &41; const


code: bool operator&61;&61; &40; const UObject &42; rhs &41; const


code: FEntry &40; UObject &42; InSubObject, ELifetimeCondition InNetCondition &41;


description: Find the NetCondition of a SubObject. Returns COND_MAX if not registered

code: ELifetimeCondition GetNetCondition ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * SubObject ) const


className: FEntry

code: struct FEntry

NetCondition

description: The network condition that chooses which connection this subobject can be replicated to.


description: Returns the list of registered subobjects

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FSubObjectRegistry::FEntry](API\Runtime\NetCore\Net\Core\Misc\FSubObjectRegistry\FEntry) > & GetRegistryList() const


description: Returns true if the subobject is contained in this list

code: bool IsSubObjectInRegistry ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * SubObject ) const


description: Remove the subobject from the replicated list. Returns true if the subobject had been registered.

code: bool RemoveSubObject ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * InSubObject )


className: FSubObjectRegistry

description: Stores the SubObjects to replicate and the network condition dictating to which connection they can replicate to.

code: struct FSubObjectRegistry


className: bDestructElements

code: enum { bDestructElements = (TIsTriviallyDestructible<T>::Value ? 0U : 1U) }


className: bConstructElements

code: enum { bConstructElements = (TIsPODType<T>::Value ? 0U : 1U) }


description: Current allocated Capacity

code: SIZE_T AllocatedCapacity() const


description: Gets the number of elements in the queue.

code: SIZE_T Count() const


description: Empty queue and release memory

code: void Empty()


description: Push single element to the back of the Queue

code: void Enqueue ( const [ElementT](API\Runtime\NetCore\Net\Core\Misc\TResizableCircularQueue\ElementT) & SrcData )


description: Returns true if the queue is empty

code: bool IsEmpty() const


description: Peek at front element

code: const [ElementT](API\Runtime\NetCore\Net\Core\Misc\TResizableCircularQueue\ElementT) & Peek() const


description: Peek with the given offset from the front of the queue

code: const [ElementT](API\Runtime\NetCore\Net\Core\Misc\TResizableCircularQueue\ElementT) & PeekAtOffset ( SIZE_T Offset ) const


description: Unchecked version, Peek with the given offset from the front of the queue

code: const [ElementT](API\Runtime\NetCore\Net\Core\Misc\TResizableCircularQueue\ElementT) & PeekAtOffsetNoCheck ( SIZE_T Offset ) const


description: Peek at front element with no check

code: const [ElementT](API\Runtime\NetCore\Net\Core\Misc\TResizableCircularQueue\ElementT) & PeekNoCheck() const


description: Poke at the element with the given offset from the front of the queue

code: [ElementT](API\Runtime\NetCore\Net\Core\Misc\TResizableCircularQueue\ElementT) & PokeAtOffset ( SIZE_T Offset )


code: [ElementT](API\Runtime\NetCore\Net\Core\Misc\TResizableCircularQueue\ElementT) & PokeAtOffsetNoCheck ( SIZE_T Offset )


description: Peek at front element


description: Pop elements from the front of the queue

code: void Pop()


description: Unchecked version, Pop a single element from the front of the queue

code: void PopNoCheck()


description: Unchecked version, Pop Count elements from the front of the queue

code: void PopNoCheck ( SIZE_T Count )


description: Pop Count elements from the front of the queue

code: void Pop ( SIZE_T Count )


className: StorageT

code: typedef [TArray](API\Runtime\Core\Containers\TArray)< [ElementT](API\Runtime\NetCore\Net\Core\Misc\TResizableCircularQueue\ElementT), AllocatorT > StorageT


description: Empty queue without releasing memory

code: void Reset()


description: Trim memory usage to the next power of two for the current size

code: void Trim()


description: Construct Empty Queue with the given initial Capacity, Capacity must be a power of two since we rely on unsigned arithmetics for wraparound

code: TResizableCircularQueue ( SIZE_T InitialCapacity )


className: TResizableCircularQueue

description: InitialCapacity must be a power of two.

code: template<typename T, typename AllocatorT> class TResizableCircularQueue


code: static bool FullCompare ( [FNetHandle](API\Runtime\NetCore\Net\Core\NetHandle\FNetHandle) A, [FNetHandle](API\Runtime\NetCore\Net\Core\NetHandle\FNetHandle) B )


code: [FNetHandle](API\Runtime\NetCore\Net\Core\NetHandle\FNetHandle) & operator= ( const [FNetHandle](API\Runtime\NetCore\Net\Core\NetHandle\FNetHandle) & Other )


code: [FNetHandle](API\Runtime\NetCore\Net\Core\NetHandle\FNetHandle) & operator= ( [FNetHandle](API\Runtime\NetCore\Net\Core\NetHandle\FNetHandle) && Other )


code: bool operator< ( [FNetHandle](API\Runtime\NetCore\Net\Core\NetHandle\FNetHandle) Other ) const


code: bool operator!= ( [FNetHandle](API\Runtime\NetCore\Net\Core\NetHandle\FNetHandle) Other ) const


code: bool operator== ( [FNetHandle](API\Runtime\NetCore\Net\Core\NetHandle\FNetHandle) Other ) const


code: FNetHandle ( const [FNetHandle](API\Runtime\NetCore\Net\Core\NetHandle\FNetHandle) & Other )


code: FNetHandle &40; FObjectKey ObjectKey &41;


code: FNetHandle ( [FNetHandle](API\Runtime\NetCore\Net\Core\NetHandle\FNetHandle) && Other )


code: FNetHandle &40; uint64 InInternalValue &41;


className: FNetHandle

description: FNetHandlecan be used to uniquely identify a replicated object for the lifetime of the application.

code: class FNetHandle

InternalValue

type: FInternalValue


className: FNetHandleDestroyer

description: This class restricts access to DestroyNetHandle functionality as early destruction prevents further dirty state tracking.

code: class FNetHandleDestroyer


code: FNetHandle &40; FInternalValue InInternalValue &41;


description: Destroys the instance if it exists.

code: static void Deinit()


description: Creates a new instance that is used by functions that need it. Checks that no instance exists.

code: static void Init()


description: Returns an existing NetHandle for an object if it's present or creates one if it's not. AssumesInit()has been called.

code: static [FNetHandle](API\Runtime\NetCore\Net\Core\NetHandle\FNetHandle) GetOrCreateNetHandle ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * )


className: Instance

code: static [FPimpl](API\Runtime\NetCore\Net\Core\NetHandle\FNetHandleManager\FPimpl) * Instance = nullptr;


description: Returns the NetHandle for an object if it's present. AssumesInit()has been called.

code: static [FNetHandle](API\Runtime\NetCore\Net\Core\NetHandle\FNetHandle) GetNetHandle ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * )


description: Returns a NetHandle given an Id that has previously been extracted from a valid NetHandle. The behavior is implementation defined if the Id was not extracted from a valid NetHandle.

code: static [FNetHandle](API\Runtime\NetCore\Net\Core\NetHandle\FNetHandle) MakeNetHandleFromId ( uint32 Id )


className: FNetHandleManager

description: Manages the association between aUObjectand aFNetHandle, which can be used to uniquely identify a replicated object for the lifetime of the application.

code: class FNetHandleManager

FNetCoreModule

type: friend


code: namespace UE { namespace Net { uint32 UE::Net::GetTypeHash ( [FNetHandle](API\Runtime\NetCore\Net\Core\NetHandle\FNetHandle) Handle ) } }


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FRepChangedPropertyTracker](API\Runtime\NetCore\Net\Core\PropertyConditions\FRepChangedPropertyTracker) > FindOrCreatePropertyTracker ( const [FObjectKey](API\Runtime\CoreUObject\UObject\FObjectKey) ObjectKey )


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FRepChangedPropertyTracker](API\Runtime\NetCore\Net\Core\PropertyConditions\FRepChangedPropertyTracker) > FindPropertyTracker ( const [FObjectKey](API\Runtime\CoreUObject\UObject\FObjectKey) ObjectKey ) const


code: void LogMemory ( [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Ar )


code: void NotifyObjectDestroyed ( const [FObjectKey](API\Runtime\CoreUObject\UObject\FObjectKey) ObjectKey )


code: void SetPropertyActive ( const [FObjectKey](API\Runtime\CoreUObject\UObject\FObjectKey) ObjectKey, const uint16 RepIndex, const bool bActive )


code: static void SetPropertyActiveOverride ( [IRepChangedPropertyTracker](API\Runtime\CoreUObject\UObject\IRepChangedPropertyTracker) & Tracker, [UObject](API\Runtime\CoreUObject\UObject\UObject) * OwningObject, const uint16 RepIndex, const bool bIsActive )


code: void SetPropertyDynamicCondition ( const [FObjectKey](API\Runtime\CoreUObject\UObject\FObjectKey) ObjectKey, const uint16 RepIndex, const ELifetimeCondition Condition )


className: FNetPropertyConditionManager

code: class FNetPropertyConditionManager


code: ELifetimeCondition GetDynamicCondition ( uint16 ParentIndex ) const


description: Used when tracking memory to gather the total size of a given instance. This should include the dynamically allocated data, as well as the classes size.

code: virtual void CountBytes ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar ) const


code: bool IsParentActive ( uint16 ParentIndex ) const


description: Deprecated* No longer used, ActiveState must be constructed with the correct number of properties.

code: void InitActiveParents ( int32 ParentCount )


code: virtual void SetCustomIsActiveOverride ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * OwningObject, const uint16 RepIndex, const bool bIsActive )


code: FRepChangedPropertyTracker ( [FCustomPropertyConditionState](API\Runtime\CoreUObject\UObject\FCustomPropertyConditionState) && InActiveState )


code: virtual ~FRepChangedPropertyTracker()


description: Deprecated* Replay arguments no longer used.

code: FRepChangedPropertyTracker ( const bool InbIsReplay, const bool InbIsClientReplayRecording )


className: FRepChangedPropertyTracker

description: TODO: This class (and arguablyIRepChangedPropertyTracker) should be renamed to reflect what they actually do now.

code: class FRepChangedPropertyTracker : public [IRepChangedPropertyTracker](API\Runtime\CoreUObject\UObject\IRepChangedPropertyTracker)


code: namespace UE { namespace Net { template<int32 Scale> bool UE::Net::SerializeQuantizedVector ( FVector & Value, [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar ) } }


code: namespace ENetTraceVerbosity { enum Type { None = 0, Trace, Verbose, VeryVerbose, } }


className: FNetDebugName

code: struct FNetDebugName

DebugNameId

type: FNetDebugNameId

Name

type: const TCHAR ...


className: FNetDebugNameId

description: NetDebugName, carries both string pointer and a debugname id assigned by the persistent debug storage. DebugNameId is used to be able to avoid hashing already seen NetDebugNames

code: typedef uint16 FNetDebugNameId


code: namespace UE { namespace Net { const [FNetDebugName](API\Runtime\NetCore\Net\Core\Trace\FNetDebugName) * UE::Net::CreatePersistentNetDebugName ( const TCHAR * Name ) } }


description: Transform any raw buffer into aFNetBitArrayView

code: namespace UE { namespace Net { [FNetBitArrayView](API\Runtime\NetCore\Net\Core\FNetBitArrayView) UE::Net::MakeNetBitArrayView ( const [FNetBitArrayView::StorageWordType](API\Runtime\NetCore\Net\Core\FNetBitArrayBase\StorageWordType) * Storage, uint32 BitCount ) } }


description: Transform aFNetBitArrayinto aFNetBitArrayView

code: namespace UE { namespace Net { [FNetBitArrayView](API\Runtime\NetCore\Net\Core\FNetBitArrayView) UE::Net::MakeNetBitArrayView ( const [FNetBitArray](API\Runtime\NetCore\Net\Core\FNetBitArray) & BitArray ) } }


description: Transform aFNetBitArrayinto aFNetBitArrayViewwithout validating the contents of the bit array received

code: namespace UE { namespace Net { [FNetBitArrayView](API\Runtime\NetCore\Net\Core\FNetBitArrayView) UE::Net::MakeNetBitArrayView ( [FNetBitArray](API\Runtime\NetCore\Net\Core\FNetBitArray) & BitArray, const [FNetBitArrayBase::ENoResetNoValidateType](API\Runtime\NetCore\Net\Core\FNetBitArrayBase\ENoResetNoValidateType) ) } }


className: FFastArrayDeltaSerializeParams

code: struct FFastArrayDeltaSerializeParams

ArraySerializer

type: FFastArraySeria...

DeltaSerializeInfo

type: FNetDeltaSerial...

PostReplicatedAdd

type: constTFunction...

ReadAddedElements

type: TArray< int32, ...

WriteBaseState

type: FNetFastTArrayB...

WriteChangedElements

type: TArray<FFastAr...


code: FFastArraySerializer_FastArrayDeltaSerialize_FIdxIDPair ( int32 _idx, int32 _id )


description: Struct used only inFFastArraySerializer::FastArrayDeltaSerialize, however, declaring it within the templated function causes crashes on some clang compilers


className: CPostReplicatedReceiveFuncable

description: Intentionally commented out, as we do not want to call this method unless it is defined by the derived type void PostReplicatedReceive(const FPostReplicatedReceiveParameters& Parameters)

code: struct CPostReplicatedReceiveFuncable


code: template<typename InFastArrayType, typename...> auto Requires &40; InFastArrayType &42; FastArray, const FFastArraySerializer::FPostReplicatedReceiveParameters & Parameters &41;


className: CVarMaxNumberOfAllowedChangesPerUpdate


code: const EFastArraySerializerDeltaFlags GetDeltaSerializationFlags() const


description: The function that implements FastTArrayReplication

code: template<typename Type, typename SerializerType> static bool FastArrayDeltaSerialize ( [TArray](API\Runtime\Core\Containers\TArray)< Type > & Items, [FNetDeltaSerializeInfo](API\Runtime\CoreUObject\UObject\FNetDeltaSerializeInfo) & Parms, SerializerType & ArraySerializer )


className: FPostReplicatedReceiveParameters

description: If a function with the signature void PostReplicatedReceive(const FFastArraySerializer::FPostReplicatedReceiveParameters& Parameters) is defined in the derived struct It will be called after each call to NetDeltaSerialize on the receiving end, including if we have mapped some unmapped objects

code: struct FPostReplicatedReceiveParameters

bHasMoreUnmappedReferences

type: uint32:  1U

OldArraySize

description: This is the size that the array had before the receive.


code: static const int32 GetMaxNumberOfAllowedChangesPerUpdate()


code: static const int32 GetMaxNumberOfAllowedDeletionsPerUpdate()


description: This must be called if you just remove something from the array

code: void MarkArrayDirty()


code: void IncrementArrayReplicationKey()


description: This must be called if you add or change an item in the array

code: void MarkItemDirty ( [FFastArraySerializerItem](API\Runtime\NetCore\Net\Serialization\FFastArraySerializerItem) & Item )


description: FExampleItemEntry

code: void PostReplicatedAdd ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< int32 > & AddedIndices, int32 FinalSize )


className: MaxNumberOfAllowedDeletionsPerUpdate

code: static int32 MaxNumberOfAllowedDeletionsPerUpdate = 2048;


description: FExampleItemEntry

code: void PostReplicatedChange ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< int32 > & ChangedIndices, int32 FinalSize )


description: FExampleItemEntry

code: void PreReplicatedRemove ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< int32 > & RemovedIndices, int32 FinalSize )


code: void SetDeltaSerializationEnabled ( const bool bEnabled )


description: Helper function for FastArrayDeltaSerialize to consolidate the logic of whether to consider writing an item in a fastTArrayduring network serialization. For client replay recording, we don't want to write any items that have been added to the array predictively.

code: template<typename Type, typename SerializerType> bool ShouldWriteFastArrayItem ( const Type & Item, const bool bIsWritingOnClient ) const


className: MaxNumberOfAllowedChangesPerUpdate

code: static int32 MaxNumberOfAllowedChangesPerUpdate = 2048;


className: FFastArraySerializer

description: Base struct for wrapping the array used in FastTArrayReplication

code: struct FFastArraySerializer

ArrayReplicationKey

description: Counter used to track array replication.

GuidReferencesMap

type: TMap< int32,FF...

type: TMap< int32, FG...

description: List of items that need to be re-serialized when the referenced objects are mapped.

IDCounter

description: Counter used to assign IDs to new elements.

ItemMap

type: TMap< int32, in...

description: Maps Element ReplicationID to ArrayIndex.


className: FFastArraySerializerGuidReferences

description: Struct for holding guid references

Buffer

type: TArray< uint8 >

description: Buffer of data to re-serialize when the guids are mapped

MappedDynamicGUIDs

type: TSet<FNetworkG...

description: List of guids that were mapped so we can move them to unmapped when necessary (i.e. actor channel closes)

NumBufferBits

description: Number of bits in the buffer

UnmappedGUIDs

description: List of guids that were unmapped so we can quickly check


description: FExampleItemEntry


code: [FFastArraySerializerItem](API\Runtime\NetCore\Net\Serialization\FFastArraySerializerItem) & operator= ( const [FFastArraySerializerItem](API\Runtime\NetCore\Net\Serialization\FFastArraySerializerItem) & In )


description: FExampleItemEntry

code: void PreReplicatedRemove ( const struct [FFastArraySerializer](API\Runtime\NetCore\Net\Serialization\FFastArraySerializer) & InArraySerializer )


description: FExampleItemEntry

code: void PostReplicatedChange ( const struct [FFastArraySerializer](API\Runtime\NetCore\Net\Serialization\FFastArraySerializer) & InArraySerializer )


description: FExampleItemEntry

code: void PostReplicatedAdd ( const struct [FFastArraySerializer](API\Runtime\NetCore\Net\Serialization\FFastArraySerializer) & InArraySerializer )


code: FFastArraySerializerItem ( const [FFastArraySerializerItem](API\Runtime\NetCore\Net\Serialization\FFastArraySerializerItem) & InItem )


className: FFastArraySerializerItem

description: Base struct for items using FastTArrayReplication

code: struct FFastArraySerializerItem


code: virtual bool IsStateEqual ( [INetDeltaBaseState](API\Runtime\CoreUObject\UObject\INetDeltaBaseState) * OtherState )


description: Used when tracking memory to gather the total size of a given instance. This should include the dynamically allocated data, as well as the classes size.

code: virtual void CountBytes ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar ) const


className: FNetFastTArrayBaseState

description: CustomINetDeltaBaseStateused by Fast Array Serialization

code: class FNetFastTArrayBaseState : public [INetDeltaBaseState](API\Runtime\CoreUObject\UObject\INetDeltaBaseState)

IDToCLMap

description: Maps an element's Replication ID toIndex.


className: FastArrayItemType

code: typedef typename [TRemovePointer](API\Runtime\Core\Templates\TRemovePointer)< typename std::decay< decltype(FastArrayTypePtr)>::type >::Type FastArrayItemType


className: FastArrayTypePtr

description: Helper to always return a Type even if GetFastArrayItemTypePtr is not defined.

code: static constexpr auto FastArrayTypePtr = [] { if constexpr (TModels_V<CGetFastArrayItemTypeFuncable, FastArrayType>) { return FastArrayType::GetFastArrayItemTypePtr(); } else { return static_cast<int*>(nullptr); } }();


description: Returns true if auto detected FastArrayItemType is a valid FastArrayItemType

code: static constexpr bool HasValidFastArrayItemType()


className: TFastArrayTypeHelper

description: ReplicationID and ReplicationKeys are set by the MarkItemDirty function onFFastArraySerializer. These are just int32s that are assigned in order as things change. There is nothing special about them other than being unique. Helper to get auto-deduced FastArrayItemType from FastArraySerializer

code: template<typename FastArrayType> class TFastArrayTypeHelper


description:
Flushes file handle to disk.
true if operation completed successfully.

module: NetworkFile

code: virtual bool Flush ( const bool bFullFlush )


description:
Read bytes from the file.
true if the operation completed successfully.

code: virtual bool Read ( uint8 * Destination, int64 BytesToRead )


description:
Change the current write or read position, relative to the end of the file.
true if the operation completed successfully.

code: virtual bool SeekFromEnd ( int64 NewPositionRelativeToEnd )


description:
Change the current write or read position.
true if the operation completed successfully.

code: virtual bool Seek ( int64 NewPosition )


description: Return the current write or read position.

code: virtual int64 Tell()


description:
Truncate the file to the given size (in bytes).
true if the operation completed successfully.

code: virtual bool Truncate ( int64 NewSize )


description:
Write bytes to the file.
true if the operation completed successfully.

code: virtual bool Write ( const uint8 * Source, int64 BytesToWrite )


code: FNetworkFileHandle ( [FNetworkPlatformFile](API\Runtime\NetworkFile\FNetworkPlatformFile) & InNetwork, const TCHAR * InFilename, int64 InFilePos, int64 InFileSize, bool bWriting )


className: FNetworkFileHandle

code: class FNetworkFileHandle : public [IFileHandle](API\Runtime\Core\GenericPlatform\IFileHandle)


className: BulkFileExtension

code: static [FString](API\Runtime\Core\Containers\FString) BulkFileExtension = TEXT(".ubulk");


description: Convert the given filename from the server to the client version of it NOTE: Potentially modifies the input FString!!!!

code: virtual void ConvertServerFilenameToClientFilename ( [FString](API\Runtime\Core\Containers\FString) & FilenameToConvert )


code: static void ConvertServerFilenameToClientFilename ( [FString](API\Runtime\Core\Containers\FString) & FilenameToConvert, const [FString](API\Runtime\Core\Containers\FString) & InServerEngineDir, const [FString](API\Runtime\Core\Containers\FString) & InServerProjectDir, const [FString](API\Runtime\Core\Containers\FString) & InServerEnginePlatformExtensionsDir, const [FString](API\Runtime\Core\Containers\FString) & InServerProjectPlatformExtensionsDir )


description:
Converts passed in filename to use an absolute path (for reading).
filename using absolute path

code: virtual [FString](API\Runtime\Core\Containers\FString) ConvertToAbsolutePathForExternalAppForRead ( const TCHAR * Filename )


description:
Converts passed in filename to use an absolute path (for writing)
filename using absolute path

code: virtual [FString](API\Runtime\Core\Containers\FString) ConvertToAbsolutePathForExternalAppForWrite ( const TCHAR * Filename )


description: Create a directory and return true if the directory was created or already existed.

code: virtual bool CreateDirectory ( const TCHAR * Directory )


description:
Copy a file. This will fail if the destination file already exists.
true if the file was copied sucessfully.

code: virtual bool CopyFile ( const TCHAR * To, const TCHAR * From, EPlatformFileRead ReadFlags, EPlatformFileWrite WriteFlags )


description: Create a directory, including any parent directories and return true if the directory was created or already existed.

code: virtual bool CreateDirectoryTree ( const TCHAR * Directory )


description: Delete a directory and return true if the directory was deleted or otherwise does not exist.

code: virtual bool DeleteDirectory ( const TCHAR * Directory )


description:
Delete all files and subdirectories in a directory, then delete the directory itself
true if the directory was deleted or did not exist.

code: virtual bool DeleteDirectoryRecursively ( const TCHAR * Directory )


description: Delete a file and return true if the file exists. Will not delete read only files.

code: virtual bool DeleteFile ( const TCHAR * Filename )


description: Return true if the directory exists.

code: virtual bool DirectoryExists ( const TCHAR * Directory )


className: ExpFileExtension

code: static [FString](API\Runtime\Core\Containers\FString) ExpFileExtension = TEXT(".uexp");


description: Implementation of Exec that is called on all targets where UE_ALLOW_EXEC_COMMANDS is true

code: virtual bool Exec_Runtime ( class [UWorld](API\Runtime\Engine\Engine\UWorld) * InWorld, const TCHAR * Cmd, [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Ar )


description: Return true if the file exists.

code: virtual bool FileExists ( const TCHAR * Filename )


description: Return the size of the file, or -1 if it doesn't exist.

code: virtual int64 FileSize ( const TCHAR * Filename )


code: virtual void FillGetFileList ( [FNetworkFileArchive](API\Runtime\Sockets\FNetworkFileArchive) & Payload )


description: Return the last access time of a file. ReturnsFDateTime::MinValue()on failure

code: virtual [FDateTime](API\Runtime\Core\Misc\FDateTime) GetAccessTimeStamp ( const TCHAR * Filename )


code: virtual void GetFileInfo ( const TCHAR * Filename, [FFileInfo](API\Runtime\Sockets\FFileInfo) & Info )


description: For case insensitive filesystems, returns the full path of the file with the same case as in the filesystem

code: virtual [FString](API\Runtime\Core\Containers\FString) GetFilenameOnDisk ( const TCHAR * Filename )


className: FontFileExtension

code: static [FString](API\Runtime\Core\Containers\FString) FontFileExtension = TEXT(".ufont");


description: Gets the platform file wrapped by this file.

code: virtual [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile) * GetLowerLevel()


description: Gets this platform file type name.

code: virtual const TCHAR * GetName() const


description: Return the stat data for the given file or directory. Check theFFileStatData::bIsValidmember before using the returned data

code: virtual [FFileStatData](API\Runtime\Core\GenericPlatform\FFileStatData) GetStatData ( const TCHAR * FilenameOrDirectory )


description: Return the modification time of a file. ReturnsFDateTime::MinValue()on failure

code: virtual [FDateTime](API\Runtime\Core\Misc\FDateTime) GetTimeStamp ( const TCHAR * Filename )


code: virtual void GetTimeStampPair ( const TCHAR * PathA, const TCHAR * PathB, [FDateTime](API\Runtime\Core\Misc\FDateTime) & OutTimeStampA, [FDateTime](API\Runtime\Core\Misc\FDateTime) & OutTimeStampB )


code: virtual [FString](API\Runtime\Core\Containers\FString) GetVersionInfo() const


code: static const TCHAR * GetTypeName()


description:
Initializes platform file.
true if the initialization was successful, false otherise.

code: virtual bool Initialize ( [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile) * Inner, const TCHAR * CmdLine )


description: Performs initialization of the platform file after it has become the active (FPlatformFileManager.GetPlatformFile()will return this

code: virtual void InitializeAfterSetActive()


description:
Initialize network platform file give the specified host IP
true if the initialization succeeded, false otherwise

code: virtual bool InitializeInternal ( [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile) * Inner, const TCHAR * HostIP )


description: Return true if the file is read only.

code: virtual bool IsReadOnly ( const TCHAR * Filename )


description:
Call the Visit function of the visitor once for each file or directory in a single directory. This function does not explore subdirectories.
false if the directory did not exist or if the visitor returned false.

code: virtual bool IterateDirectory ( const TCHAR * Directory, [IPlatformFile::FDirectoryVisitor](API\Runtime\Core\GenericPlatform\IPlatformFile\FDirectoryVisitor) & Visitor )


description:
Call the Visit function of the visitor once for each file or directory in a directory tree. This function explores subdirectories.
false if the directory did not exist or if the visitor returned false.

code: virtual bool IterateDirectoryRecursively ( const TCHAR * Directory, [IPlatformFile::FDirectoryVisitor](API\Runtime\Core\GenericPlatform\IPlatformFile\FDirectoryVisitor) & Visitor )


code: virtual bool IterateDirectoryStat ( const TCHAR * Directory, [IPlatformFile::FDirectoryStatVisitor](API\Runtime\Core\GenericPlatform\IPlatformFile\FDirectoryStatVisitor) & Visitor )


description: Does normal path standardization, and also any extra modifications to make string comparisons against the internal directory list work properly.

code: void MakeStandardNetworkFilename ( [FString](API\Runtime\Core\Containers\FString) & Filename )


code: virtual bool IterateDirectoryStatRecursively ( const TCHAR * Directory, [IPlatformFile::FDirectoryStatVisitor](API\Runtime\Core\GenericPlatform\IPlatformFile\FDirectoryStatVisitor) & Visitor )


description: Attempt to move a file. Return true if successful. Will not overwrite existing files.

code: virtual bool MoveFile ( const TCHAR * To, const TCHAR * From )


code: virtual void OnFileUpdated ( const [FString](API\Runtime\Core\Containers\FString) & LocalFilename )


code: static [FString](API\Runtime\Core\Containers\FString) MP4Extension = TEXT(".mp4");


description: Attempt to open a file for writing. If successful will return a non-nullptr pointer. Close the file by delete'ing the handle.

code: virtual [IFileHandle](API\Runtime\Core\GenericPlatform\IFileHandle) * OpenWrite ( const TCHAR * Filename, bool bAppend, bool bAllowRead )


code: virtual void ProcessServerCachedFilesResponse ( [FArrayReader](API\Runtime\Core\Serialization\FArrayReader) & InReponse, const [FPackageFileVersion](API\Runtime\Core\UObject\FPackageFileVersion) & ServerPackageVersion, const int32 ServerPackageLicenseeVersion )


description: Send a heartbeat message to the file server. This will tell it we are alive, as well as get back a list of files that have been updated on the server (so we can toss our copy)

code: virtual void PerformHeartbeat()


description:
Attempt to open a file for reading.
If successful will return a non-nullptr pointer. Close the file by delete'ing the handle.

code: virtual [IFileHandle](API\Runtime\Core\GenericPlatform\IFileHandle) * OpenRead ( const TCHAR * Filename, bool bAllowWrite )


code: virtual void ProcessServerInitialResponse ( [FArrayReader](API\Runtime\Core\Serialization\FArrayReader) & InResponse, [FPackageFileVersion](API\Runtime\Core\UObject\FPackageFileVersion) & OutServerPackageVersion, int32 & OutServerPackageLicenseeVersion )


code: virtual bool SendPayloadAndReceiveResponse ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & In, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & Out )


description:
Sends a message to the file server, and will block until it's complete. Will return immediately if the file manager doesn't support talking to a server.
true if the message was sent to server and it returned success, or false if there is no server, or the command failed

code: virtual bool SendMessageToServer ( const TCHAR * Message, [IPlatformFile::IFileServerMessageHandler](API\Runtime\Core\GenericPlatform\IPlatformFile\IFileServerMessageHandler) * Handler )


code: virtual bool ReceiveResponse ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & Out )


description: Sets the platform file wrapped by this file.

code: virtual void SetLowerLevel ( [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile) * NewLowerLevel )


code: bool SendReadMessage ( uint8 * Destination, int64 BytesToRead )


code: bool SendWriteMessage ( const uint8 * Source, int64 BytesToWrite )


description: Attempt to change the read only status of a file. Return true if successful.

code: virtual bool SetReadOnly ( const TCHAR * Filename, bool bNewReadOnlyValue )


description: Checks if this platform file should be used even though it was not asked to be. i.e. pak files exist on disk so we should use a pak file

code: virtual bool ShouldBeUsed ( [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile) * Inner, const TCHAR * CmdLine ) const


description: Platform file can override this to get a regular tick from the engine

code: virtual void Tick()


description: Sets the modification time of a file

code: virtual void SetTimeStamp ( const TCHAR * Filename, [FDateTime](API\Runtime\Core\Misc\FDateTime) DateTime )


description: Constructor

code: FNetworkPlatformFile()


className: FNetworkPlatformFile

description: Wrapper to redirect the low level file system to a server

code: class FNetworkPlatformFile : public [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile), public [FSelfRegisteringExec](API\Runtime\Core\Misc\FSelfRegisteringExec)

bHasLoadedDDCDirectories

type: bool

description: This is true after the DDC directories have been loaded from the DDC system

CachedLocalFiles

type: TSet<FString>

description: This keeps track of what files have been "EnsureFileIsLocal'd"

ConnectionFlags

type: EConnectionFlag...

description: The connection flags are passed to the server during GetFileList the server may cache them

HeartbeatFrequency

type: float

description: Frequency to send heartbeats to server in seconds set to negative number to disable.

InnerPlatformFile

type: IPlatformFile&...

description: The file interface to read/write local files with

LocalDirectories

type: TArray<FString...

description: Set of directories that should use the local filesystem

LocalDirectoriesCriticalSection

type: FCriticalSectio...

ServerEngineDir

type: FString

description: The server engine dir

ServerEnginePlatformExtensionsDir

description: The server engine platform extensions dir

ServerFiles

type: FServerTOC

description: This is the "TOC" of the server

ServerProjectDir

description: The server game dir

ServerProjectPlatformExtensionsDir

description: The server project platform extensions dir

TotalNetworkSyncTime

type: double

TotalWriteTime

description: Some stats for messuring network platform file performance


module: NetworkFileSystem

code: FNetworkFileDelegateContainer()


className: FNetworkFileServerOptions

description: Network file server options.

code: struct FNetworkFileServerOptions

bRestrictPackageAssetsToSandbox

description: When running cook on the fly this options restricts package assets being sent from the project content folder

Delegates

type: FNetworkFileDel...

description: Optional delegates to be invoked when a file is requested by a client

Port

description: The port number to bind to (-1 = default port, 0 = any available port)

Protocol

type: ENetworkFileSer...

description: File server protocol

TargetPlatforms

type: TArray<ITarget...

description: Active target platform(s)


className: FNetworkFileDelegateContainer

description: Container struct for delegates which the network file system uses

code: struct FNetworkFileDelegateContainer

FileRequestDelegate

type: FFileRequestDel...

NewConnectionDelegate

type: FNewConnectionD...

OnFileModifiedCallback

type: FOnFileModified...

RecompileShadersDelegate

type: FRecompileShade...

SandboxPathOverrideDelegate

type: FSandboxPathDel...


description:
Gets the list of local network addresses that the file server listens on.
true on success, false otherwise.

code: bool GetAddressList ( [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FInternetAddr](API\Runtime\Sockets\FInternetAddr) > > & OutAddresses ) const


description: Destructor

code: virtual ~FNetworkPlatformFile()


description:
Returns Whether the network server was able to successfully start or not.
true on success, false otherwise.


description:
Gets the number of active connections.
The number of connections.

code: int32 NumConnections() const


description: Shuts down the file server.

code: void Shutdown()


description: Virtual destructor.

code: virtual ~INetworkFileServer()


description:
Creates a new network file server for COTF.
The new file server, or nullptr if creation failed.

code: virtual [INetworkFileServer](API\Runtime\NetworkFileSystem\INetworkFileServer) * CreateNetworkFileServer ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< UE::Cook::ICookOnTheFlyNetworkServer > CookOnTheFlyNetworkServer, [FNetworkFileDelegateContainer](API\Runtime\NetworkFileSystem\FNetworkFileDelegateContainer) Delegates ) const


description:
Creates a new network file server.
The new file server, or nullptr if creation failed.

code: [INetworkFileServer](API\Runtime\NetworkFileSystem\INetworkFileServer) * CreateNetworkFileServer ( [FNetworkFileServerOptions](API\Runtime\NetworkFileSystem\FNetworkFileServerOptions) FileServerOptions, bool bLoadTargetPlatforms ) const


className: INetworkFileServer

description: Interface for network file servers.

code: class INetworkFileServer


code: [INetworkFileServer](API\Runtime\NetworkFileSystem\INetworkFileServer) * CreateNetworkFileServer ( bool bLoadTargetPlatforms, int32 Port, [FNetworkFileDelegateContainer](API\Runtime\NetworkFileSystem\FNetworkFileDelegateContainer) InNetworkFileDelegateContainer, const ENetworkFileServerProtocol Protocol ) const


description: Virtual destructor.

code: virtual ~INetworkFileSystemModule()


className: INetworkFileSystemModule

description: Interface for network file system modules.

code: class INetworkFileSystemModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


description: Stop

module: Networking

code: virtual void Exit()


description:
Gets the listener's local IP endpoint.
IP endpoint.

code: const [FIPv4Endpoint](API\Runtime\Networking\Interfaces\IPv4\FIPv4Endpoint) & GetLocalEndpoint() const


description:
Gets the listener's network socket.
Network socket.

code: [FSocket](API\Runtime\Sockets\FSocket) * GetSocket() const


description: Exit

code: virtual bool Init()


description:
Checks whether the listener is listening for incoming connections.
true if it is listening, false otherwise.

code: bool IsActive() const


description:
If this delegate is not bound, the listener will reject all incoming connections. To temporarily disable accepting connections, use theEnable()and Disable() methods.
The delegate.


description: Exit

code: virtual void Stop()


description: Exit

code: virtual uint32 Run()


description: Creates and initializes a new instance from the specified IP endpoint.

code: FTcpListener ( const [FIPv4Endpoint](API\Runtime\Networking\Interfaces\IPv4\FIPv4Endpoint) & LocalEndpoint, const [FTimespan](API\Runtime\Core\Misc\FTimespan) & InSleepTime, bool bInReusable )


description: Creates and initializes a new instance from the specified socket.

code: FTcpListener ( [FSocket](API\Runtime\Sockets\FSocket) & InSocket, const [FTimespan](API\Runtime\Core\Misc\FTimespan) & InSleepTime, bool bInReusable )


description: Destructor.

code: ~FTcpListener()


className: FTcpListener

description: Implements a runnable that listens for incoming TCP connections.

code: class FTcpListener : public [FRunnable](API\Runtime\Core\HAL\FRunnable)


description: AsReusable


description: AsNonBlocking


description: AsNonBlocking

code: [FTcpSocketBuilder](API\Runtime\Networking\Common\FTcpSocketBuilder) AsReusable ( bool bInReusable )


description: BoundToPort

code: [FTcpSocketBuilder](API\Runtime\Networking\Common\FTcpSocketBuilder) BoundToEndpoint ( const [FIPv4Endpoint](API\Runtime\Networking\Interfaces\IPv4\FIPv4Endpoint) & Endpoint )


description: BoundToEndpoint

code: [FTcpSocketBuilder](API\Runtime\Networking\Common\FTcpSocketBuilder) BoundToPort ( int32 Port )


description: BoundToPort

code: [FTcpSocketBuilder](API\Runtime\Networking\Common\FTcpSocketBuilder) BoundToAddress ( const [FIPv4Address](API\Runtime\Networking\Interfaces\IPv4\FIPv4Address) & Address )


description:
Sets how long the socket will linger after closing.
This instance (for method chaining).

code: [FTcpSocketBuilder](API\Runtime\Networking\Common\FTcpSocketBuilder) Lingering ( int32 Timeout )


description:
Builds the socket as configured.
The built socket.

code: [FSocket](API\Runtime\Sockets\FSocket) * Build() const


description:
Sets the socket into a listening state for incoming connections.
This instance (for method chaining).

code: [FTcpSocketBuilder](API\Runtime\Networking\Common\FTcpSocketBuilder) Listening ( int32 MaxBacklog )


className: FTcpSocketBuilder::operator FSocket *

description:
Implicit conversion operator that builds the socket as configured.
The built socket.

code: operator FSocket *() const


description: WithSendBufferSize

code: [FTcpSocketBuilder](API\Runtime\Networking\Common\FTcpSocketBuilder) WithReceiveBufferSize ( int32 SizeInBytes )


className: FTcpSocketBuilder

description: Implements a fluent builder for TCP sockets.

code: class FTcpSocketBuilder


description: Creates and initializes a new instance.

code: FTcpSocketBuilder ( const [FString](API\Runtime\Core\Containers\FString) & InDescription )


description: WithReceiveBufferSize

code: [FTcpSocketBuilder](API\Runtime\Networking\Common\FTcpSocketBuilder) WithSendBufferSize ( int32 SizeInBytes )


description: BoundToPort

code: [FUdpSocketBuilder](API\Runtime\Networking\Common\FUdpSocketBuilder) & BoundToAddress ( const [FIPv4Address](API\Runtime\Networking\Interfaces\IPv4\FIPv4Address) & Address )


description: BoundToAddress

code: [FUdpSocketBuilder](API\Runtime\Networking\Common\FUdpSocketBuilder) & BoundToPort ( int32 Port )


description: BoundToPort

code: [FUdpSocketBuilder](API\Runtime\Networking\Common\FUdpSocketBuilder) & BoundToEndpoint ( const [FIPv4Endpoint](API\Runtime\Networking\Interfaces\IPv4\FIPv4Endpoint) & Endpoint )


description: WithMulticastTtl

code: [FUdpSocketBuilder](API\Runtime\Networking\Common\FUdpSocketBuilder) & JoinedToGroup ( const [FIPv4Address](API\Runtime\Networking\Interfaces\IPv4\FIPv4Address) & GroupAddress, const [FIPv4Address](API\Runtime\Networking\Interfaces\IPv4\FIPv4Address) & InterfaceAddress )


description: WithMulticastTtl

code: [FUdpSocketBuilder](API\Runtime\Networking\Common\FUdpSocketBuilder) & JoinedToGroup ( const [FIPv4Address](API\Runtime\Networking\Interfaces\IPv4\FIPv4Address) & GroupAddress )


className: FUdpSocketBuilder::operator FSocket *


description: WithMulticastLoopback

code: [FUdpSocketBuilder](API\Runtime\Networking\Common\FUdpSocketBuilder) & WithMulticastInterface ( const [FIPv4Address](API\Runtime\Networking\Interfaces\IPv4\FIPv4Address) & InterfaceAddress )


description: WithMulticastTtl


description: WithMulticastLoopback

code: [FUdpSocketBuilder](API\Runtime\Networking\Common\FUdpSocketBuilder) & WithMulticastTtl ( uint8 TimeToLive )


description: WithSendBufferSize

code: [FUdpSocketBuilder](API\Runtime\Networking\Common\FUdpSocketBuilder) & WithReceiveBufferSize ( int32 SizeInBytes )


description: WithReceiveBufferSize

code: [FUdpSocketBuilder](API\Runtime\Networking\Common\FUdpSocketBuilder) & WithSendBufferSize ( int32 SizeInBytes )


description:
Enables broadcasting.
This instance (for method chaining).


description: Creates and initializes a new instance.

code: FUdpSocketBuilder ( const [FString](API\Runtime\Core\Containers\FString) & InDescription )


className: FUdpSocketBuilder

description: Implements a fluent builder for UDP sockets.

code: class FUdpSocketBuilder


description: Stop

code: virtual void Exit()


description:
Gets single thread interface pointer used for ticking this runnable when multi-threading is disabled. If the interface is not implemented, this runnable will not be ticked when FPlatformProcess::SupportsMultithreading() is false.
Pointer to the single thread interface or nullptr if not implemented.

code: virtual [FSingleThreadRunnable](API\Runtime\Core\Misc\FSingleThreadRunnable) * GetSingleThreadInterface()


description: Exit

code: virtual bool Init()


description:
This delegate must be bound before the receiver thread is started with theStart()method. It cannot be unbound while the thread is running.
The delegate.


description: Exit

code: virtual uint32 Run()


description: Set the maximum size allocated to read off of the socket.

code: void SetMaxReadBufferSize ( uint32 InMaxReadBufferSize )


description: Start the receiver thread.

code: void Start()


description: Exit

code: virtual void Stop()


description: Update this socket receiver.

code: void Update ( const [FTimespan](API\Runtime\Core\Misc\FTimespan) & SocketWaitTime )


description: Tick function.

code: virtual void Tick()


description: Creates and initializes a new socket receiver.

code: FUdpSocketReceiver ( [FSocket](API\Runtime\Sockets\FSocket) * InSocket, const [FTimespan](API\Runtime\Core\Misc\FTimespan) & InWaitTime, const TCHAR * InThreadName )


description: Virtual destructor.

code: virtual ~FUdpSocketReceiver()


className: FUdpSocketReceiver

description: Asynchronously receives data from an UDP socket.

code: class FUdpSocketReceiver : public [FRunnable](API\Runtime\Core\HAL\FRunnable), private [FSingleThreadRunnable](API\Runtime\Core\Misc\FSingleThreadRunnable)


description:
Gets the current throughput (in bytes per second).
Current throughput.

code: uint32 GetThroughput() const


description:
Gets the maximum send rate (in bytes per second).
Current send rate.

code: uint32 GetSendRate() const


description:
Sends data to the specified recipient.
true if the data will be sent, false otherwise.

code: bool Send ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [TArray](API\Runtime\Core\Containers\TArray)< uint8 >, ESPMode::ThreadSafe > & Data, const [FIPv4Endpoint](API\Runtime\Networking\Interfaces\IPv4\FIPv4Endpoint) & Recipient )


description: SetWaitTime

code: void SetSendRate ( uint32 Rate )


description: SetSendRate

code: void SetWaitTime ( const [FTimespan](API\Runtime\Core\Misc\FTimespan) & Timespan )


description:
Update this socket sender.
true on success, false otherwise.

code: bool Update ( const [FTimespan](API\Runtime\Core\Misc\FTimespan) & SocketWaitTime )


description: Creates and initializes a new socket sender.

code: FUdpSocketSender ( [FSocket](API\Runtime\Sockets\FSocket) * InSocket, const TCHAR * ThreadDescription )


description: Virtual destructor.

code: virtual ~FUdpSocketSender()


className: FUdpSocketSender

description: Asynchronously sends data to an UDP socket.

code: class FUdpSocketSender : public [FRunnable](API\Runtime\Core\HAL\FRunnable), private [FSingleThreadRunnable](API\Runtime\Core\Misc\FSingleThreadRunnable)


description: Enumerates IPv4 subnet classes.

code: namespace EIPv4SubnetClasses { enum Type { Invalid, ClassA, ClassB, ClassC, } }


className: Any

description: Defines the wild card address, which is 0.0.0.0

code: static const [FIPv4Address](API\Runtime\Networking\Interfaces\IPv4\FIPv4Address) Any;


className: INetworkingModule

description: Interface for networking modules.

code: class INetworkingModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


className: InternalLoopback

description: Defines the internal loopback address, which is 127.0.0.1

code: static const [FIPv4Address](API\Runtime\Networking\Interfaces\IPv4\FIPv4Address) InternalLoopback;


description: IsSiteLocalMulticast

code: bool IsGlobalMulticast() const


description:
Link local addresses are in the range 169.254.0.0/16
true if it is link local, false otherwise.

code: bool IsLinkLocal() const


description: IsMulticastAddress

code: bool IsLoopbackAddress() const


description: IsSiteLocalMulticast

code: bool IsLinkLocalMulticast() const


description: IsLoopbackAddress

code: bool IsMulticastAddress() const


description: IsSiteLocalMulticast


description:
Checks whether this IP address is the multicast address we use for the Session Frontend Which is 230.0.0.1
true if this address matches, false otherwise.

code: bool IsSessionFrontendMulticast() const


description:
Site local addresses have one of the following forms: 10.x.x.x 172.16-31.x.x 192.168.x.x
true if it is a site local address, false otherwise.

code: bool IsSiteLocalAddress() const


description: IsOrganizationLocalMulticast

code: bool IsSiteLocalMulticast() const


className: LanBroadcast

description: Defines the broadcast address for the 'zero network' (i.e. LAN), which is 255.255.255.255.

code: static const [FIPv4Address](API\Runtime\Networking\Interfaces\IPv4\FIPv4Address) LanBroadcast;


description:
AND operator for masking IP addresses with a subnet mask.
The masked IP address.

code: [FIPv4Address](API\Runtime\Networking\Interfaces\IPv4\FIPv4Address) operator& ( const [FIPv4SubnetMask](API\Runtime\Networking\Interfaces\IPv4\FIPv4SubnetMask) & SubnetMask ) const


description:
Compares this IPv4 address with the given address for equality.
true if the addresses are equal, false otherwise.

code: bool operator== ( const [FIPv4Address](API\Runtime\Networking\Interfaces\IPv4\FIPv4Address) & Other ) const


description: ToText


description: ToString

code: static bool Parse ( const [FString](API\Runtime\Core\Containers\FString) & AddressString, [FIPv4Address](API\Runtime\Networking\Interfaces\IPv4\FIPv4Address) & OutAddress )


description:
Compares this IPv4 address with the given address for inequality.
true if the addresses are not equal, false otherwise.

code: bool operator!= ( const [FIPv4Address](API\Runtime\Networking\Interfaces\IPv4\FIPv4Address) & Other ) const


description: ToString


description: Default constructor.


description: Creates and initializes a new IPv4 address with the specified value.

code: FIPv4Address ( uint32 InValue )


description: The created IP address has the value A.B.C.D.

code: FIPv4Address ( uint8 InA, uint8 InB, uint8 InC, uint8 InD )


description: Defines the wild card endpoint, which is 0.0.0.0:0

code: static const [FIPv4Endpoint](API\Runtime\Networking\Interfaces\IPv4\FIPv4Endpoint) Any;


description: Implements an IPv4 address.

code: struct FIPv4Address

type: union FIPv4Addr...

Value

description: The IP address value in host byte order.


description:
Resolves a hostname and port to an IPv4 endpoint.
true if the host and port were parsed and resolved successfully, false otherwise.

code: static bool FromHostAndPort ( const [FString](API\Runtime\Core\Containers\FString) & HostAndPortString, [FIPv4Endpoint](API\Runtime\Networking\Interfaces\IPv4\FIPv4Endpoint) & OutEndpoint )


className: CachedSocketSubsystem

description: ISocketSubsystem::Get()is not thread-safe, so we cache it here.

code: static [ISocketSubsystem](API\Runtime\Sockets\ISocketSubsystem) * CachedSocketSubsystem = nullptr;


description: Initializes the IP endpoint functionality.

code: static void Initialize()


description: ToString

code: static bool Parse ( const [FString](API\Runtime\Core\Containers\FString) & EndpointString, [FIPv4Endpoint](API\Runtime\Networking\Interfaces\IPv4\FIPv4Endpoint) & OutEndpoint )


description:
Compares this IPv4 endpoint with the given endpoint for equality.
true if the endpoints are equal, false otherwise.

code: bool operator== ( const [FIPv4Endpoint](API\Runtime\Networking\Interfaces\IPv4\FIPv4Endpoint) & Other ) const


description:
Compares this IPv4 address with the given endpoint for inequality.
true if the endpoints are not equal, false otherwise.

code: bool operator!= ( const [FIPv4Endpoint](API\Runtime\Networking\Interfaces\IPv4\FIPv4Endpoint) & Other ) const


description:
Note: this method will be removed after the socket subsystem is refactored.
Internet address object representing this endpoint.

code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FInternetAddr](API\Runtime\Sockets\FInternetAddr) > ToInternetAddr() const


code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FInternetAddr](API\Runtime\Sockets\FInternetAddr) > ToInternetAddrIPV4() const


description: ToText


description: Note: this constructor will be removed after the socket subsystem has been refactored.

code: FIPv4Endpoint ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FInternetAddr](API\Runtime\Sockets\FInternetAddr) > & InternetAddr )


description: Creates and initializes a new IPv4 endpoint with the specified NetID and port.

code: FIPv4Endpoint ( const [FIPv4Address](API\Runtime\Networking\Interfaces\IPv4\FIPv4Address) & InAddress, uint16 InPort )


description: An endpoint consists of an IPv4 address and a port number.

code: struct FIPv4Endpoint

Address

description: Holds the endpoint's IP address.

Port

description: Holds the endpoint's port number.


description:
Checks whether the subnet contains the specified IP address.
true if the subnet contains the address, false otherwise.

code: bool ContainsAddress ( const [FIPv4Address](API\Runtime\Networking\Interfaces\IPv4\FIPv4Address) & TestAddress )


description:
Compares this IPv4 subnet descriptor with the given subnet for equality.
true if the subnets are equal, false otherwise.

code: bool operator== ( const [FIPv4Subnet](API\Runtime\Networking\Interfaces\IPv4\FIPv4Subnet) & Other ) const


description:
Compares this IPv4 subnet descriptor with the given subnet for inequality.
true if the subnets are not equal, false otherwise.

code: bool operator!= ( const [FIPv4Subnet](API\Runtime\Networking\Interfaces\IPv4\FIPv4Subnet) & Other ) const


description: ToString

code: static bool Parse ( const [FString](API\Runtime\Core\Containers\FString) & SubnetString, [FIPv4Subnet](API\Runtime\Networking\Interfaces\IPv4\FIPv4Subnet) & OutSubnet )


description: ToString


description: Default constructor.


description:
Get the broadcast address for this subnet.
The broadcast address.


description: Creates and initializes a new IPv4 subnet with the specified address and mask.

code: FIPv4Subnet ( const [FIPv4Address](API\Runtime\Networking\Interfaces\IPv4\FIPv4Address) & InAddress, const [FIPv4SubnetMask](API\Runtime\Networking\Interfaces\IPv4\FIPv4SubnetMask) & InMask )


description: Implements a IPv4 subnet descriptor.

code: struct FIPv4Subnet

Address

description: Holds the subnet's address.

Mask

description: Holds the subnet's mask.


description:
Gets the subnet class that this mask specifies.
Subnet class.


description:
Returns an inverted subnet mask.
Inverted subnet mask.


description:
Compares this subnet mask with the given mask for equality.
true if the subnet masks are equal, false otherwise.

code: bool operator== ( const [FIPv4SubnetMask](API\Runtime\Networking\Interfaces\IPv4\FIPv4SubnetMask) & Other ) const


description:
Compares this subnet mask with the given address for inequality.
true if the subnet masks are not equal, false otherwise.

code: bool operator!= ( const [FIPv4SubnetMask](API\Runtime\Networking\Interfaces\IPv4\FIPv4SubnetMask) & Other ) const


description: ToString

code: static bool Parse ( const [FString](API\Runtime\Core\Containers\FString) & MaskString, [FIPv4SubnetMask](API\Runtime\Networking\Interfaces\IPv4\FIPv4SubnetMask) & OutMask )


description: ToText


description: Creates and initializes a new IPv4 subnet mask with the specified value.

code: FIPv4SubnetMask ( uint32 InValue )


description: The created subnet mask has the value A.B.C.D.

code: FIPv4SubnetMask ( uint8 InA, uint8 InB, uint8 InC, uint8 InD )


description: Implements an IPv4 subnet mask.

code: struct FIPv4SubnetMask

type: union FIPv4Subn...

Value

description: The subnet mask value in host byte order.


description: GetSteamChannel

code: uint64 GetUniqueNetId() const


description: GetUniqueNetId

code: int32 GetSteamChannel() const


description:
Compares this Steam address with the given address for equality.
true if the addresses are equal, false otherwise.

code: bool operator== ( const [FSteamEndpoint](API\Runtime\Networking\Interfaces\Steam\FSteamEndpoint) & Other ) const


description:
Gets the string representation for this address.
String representation.


description:
Compares this Steam address with the given address for inequality.
true if the addresses are not equal, false otherwise.

code: bool operator!= ( const [FSteamEndpoint](API\Runtime\Networking\Interfaces\Steam\FSteamEndpoint) & Other ) const


description: Default constructor.

code: FSteamEndpoint()


description: Creates and initializes a new Steam address with the specified components.

code: FSteamEndpoint ( uint64 InUniqueNetId, int32 InSteamChannel )


className: FSteamEndpoint

description: Implements a Steam endpoint.

code: class FSteamEndpoint


description: Deprecated* No longer used

module: NetworkReplayStreaming

code: namespace ENetworkReplayError { PRAGMA_DISABLE_DEPRECATION_WARNINGS const TCHAR * ENetworkReplayError::ToString ( const ENetworkReplayError::Type FailureType ) }


className: FDeleteFinishedStreamResult

description: End Goto Types Start DeleteFinishedStream Types

code: struct FDeleteFinishedStreamResult : public [FStreamingResultBase](API\Runtime\NetworkReplayStreaming\FStreamingResultBase)


className: FDownloadHeaderResult

description: End RequestEventGroupData Types Start DownloadHeader Types

code: struct FDownloadHeaderResult : public [FStreamingResultBase](API\Runtime\NetworkReplayStreaming\FStreamingResultBase)


className: FEnumerateStreamsResult

description: End DeleteFinishedStream Types Start EnumerateStreams Types

code: struct FEnumerateStreamsResult : public [FStreamingResultBase](API\Runtime\NetworkReplayStreaming\FStreamingResultBase)

CorruptedStreams

description: A list of streams (by name) that were found and were corrupted.

FoundStreams

type: TArray<FNetwor...

description: A list of streams that were found.


className: FGotoResult

code: struct FGotoResult : public [FStreamingResultBase](API\Runtime\NetworkReplayStreaming\FStreamingResultBase)

CheckpointInfo

type: FReplayCheckpoi...

description: Info about the checkpoint that was loaded as a result of the request.

ExtraTimeMS

description: Amount of extra time that the stream may need to be fast forwarded in order to reach the exact time specified (relative to the latest checkpoint before the specified time).


className: FKeepReplayResult

description: End SearchEvent Types Start KeepReplay Types

code: struct FKeepReplayResult : public [FStreamingResultBase](API\Runtime\NetworkReplayStreaming\FStreamingResultBase)

NewReplayName

description: Saving the replay may cause the name to change.

RequiredSpace

description: Only valid if the error is NotEnoughSpace or NotEnoughSlots.


code: FNetworkReplayStreamInfo()


className: FEnumerateEventsResult

description: End EnumerateStreams Types Start EnumerateEvents Types

code: struct FEnumerateEventsResult : public [FStreamingResultBase](API\Runtime\NetworkReplayStreaming\FStreamingResultBase)

ReplayEventList

type: FReplayEventLis...

description: A list of events that were found.


className: FNetworkReplayStreamInfo

description: Struct to store information about a stream, returned from search results.

code: struct FNetworkReplayStreamInfo

bIsLive

type: bool

description: True if the stream is live and the game hasn't completed yet

bShouldKeep

description: Debug feature that allows us to mark replays to not be deleted.

Changelist

description: The changelist of the replay

FriendlyName

description: The UI friendly name of the stream

LengthInMS

description: The duration of the stream in MS

Name

description: The name of the stream (generally this is auto generated, refer to friendly name for UI)

NumViewers

description: Number of viewers viewing this stream

SizeInBytes

description: The size of the stream

Timestamp

type: FDateTime

description: The date and time the stream was recorded


code: virtual const [FString](API\Runtime\Core\Containers\FString) GetAutomaticReplayPrefixExtern() const


description: Gets the configured automatic replay name prefix. The prefix should always be a non-empty string. If using streamers that store replays on disk, this must also be comprised of only valid file name characters.


code: static [FNetworkReplayStreaming](API\Runtime\NetworkReplayStreaming\FNetworkReplayStreaming) & Get()


code: virtual [INetworkReplayStreamingFactory](API\Runtime\NetworkReplayStreaming\INetworkReplayStreamingFactory) & GetFactory ( const TCHAR * FactoryNameOverride )


code: virtual const int32 GetMaxNumberOfAutomaticReplaysExtern() const


description: Gets the configured max value for the number of automatic replays to support. 0 indicates no limit.


description: Gets the configured value for whether or not we should useFDateTime::Nowas the automatic replay postfix. If false, it's up to the streamer to determine a proper postfix.


description: Gets the file extension for replay streamers to use when recording replay files to the local file system. Includes the "." prefix


code: FNetworkReplayStreaming()


code: virtual ~FNetworkReplayStreaming()


className: FRenameReplayResult

description: End KeepReplay Types Start RenameReplay Types

code: struct FRenameReplayResult : public [FStreamingResultBase](API\Runtime\NetworkReplayStreaming\FStreamingResultBase)


className: FNetworkReplayStreaming

description: Replay streaming factory manager

code: class FNetworkReplayStreaming : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface), public [FSelfRegisteringExec](API\Runtime\Core\Misc\FSelfRegisteringExec)


description: Indicates that no checkpoint was loaded as a part of the request. This can happen if the requested time was before any available checkpoints.

code: static constexpr uint32 NO_CHECKPOINT = -1;


description: Indicates an invalid checkpoint, or a bad request.

code: static constexpr uint32 INVALID_CHECKPOINT = -2;


className: FReplayCheckpointInfo

description: End StartStreaming Types Start Goto Types

code: struct FReplayCheckpointInfo


description: FJsonSerializable.

code: virtual void Serialize ( [FJsonSerializerBase](API\Runtime\Json\Serialization\FJsonSerializerBase) & Serializer, bool bFlatObject )


code: virtual ~FReplayEventList()


className: FReplayEventList

code: class FReplayEventList : public [FJsonSerializable](API\Runtime\Json\Serialization\FJsonSerializable)

ReplayEvents

type: TArray<FReplay...


code: FReplayEventList()


code: FReplayEventListItem()


className: FReplayEventListItem

code: class FReplayEventListItem : public [FJsonSerializable](API\Runtime\Json\Serialization\FJsonSerializable)

Group

type: FString


code: virtual ~FReplayEventListItem()


className: FRequestEventDataResult

description: End EnumerateEvents Types Start RequestEventData Types

code: struct FRequestEventDataResult : public [FStreamingResultBase](API\Runtime\NetworkReplayStreaming\FStreamingResultBase)

ReplayEventListItem

type: TArray< uint8 >

description: A replay event with its data parameter filled in.


className: FStartStreamingResult

description: Start StartStreaming Types

code: struct FStartStreamingResult : public [FStreamingResultBase](API\Runtime\NetworkReplayStreaming\FStreamingResultBase)

bRecording

description: Whether or not Recording was requested (vs. Playback).


className: FSearchEventsResult

description: End DownloadHeader Types Start SearchEvent Types

code: struct FSearchEventsResult : public [FStreamingResultBase](API\Runtime\NetworkReplayStreaming\FStreamingResultBase)

CorruptedStreams

type: TArray<FString...

description: A list of streams (by name) that were found and were corrupted.

FoundStreams

description: An array containing information about the streams that were found.


code: bool WasSuccessful() const


className: FRequestEventGroupDataResult

description: End RequestEventData Types Start RequestEventGroupData Types

code: struct FRequestEventGroupDataResult : public [FStreamingResultBase](API\Runtime\NetworkReplayStreaming\FStreamingResultBase)

ReplayEventListResults

type: TArray<FReques...


className: FStartStreamingParameters

code: struct FStartStreamingParameters

ReplayVersion

type: FNetworkReplayV...

UserIndices

type: TArray< int32 >


code: virtual ~FStreamingResultBase()


className: FStreamingResultBase

description: Base type for all Streaming Operation results. Should be used to store generic result information and convenience methods.

code: struct FStreamingResultBase

Result

type: EStreamingOpera...