1. Epic GamesDeveloper
  3. FNetBlob

FNetBlob

API > API/Runtime > API/Runtime/IrisCore

   
Name FNetBlob
Type class
Header File /Engine/Source/Runtime/Net/Iris/Public/Iris/ReplicationSystem/NetBlob/NetBlob.h
Include Path #include "Iris/ReplicationSystem/NetBlob/NetBlob.h"

Syntax

class FNetBlob

Derived Classes

FNetBlob derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
Construct a NetBlob with reference count zero. Iris/ReplicationSystem/NetBlob/NetBlob.h  

FNetBlob ( const FNetBlob&
)

   Iris/ReplicationSystem/NetBlob/NetBlob.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FNetBlob()

 The destructor will free dynamic state, if present, in the state buffer and remove a reference to the descriptor. Iris/ReplicationSystem/NetBlob/NetBlob.h  

Structs

Name Remarks
FQuantizedBlobState  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
RefCount int32   Iris/ReplicationSystem/NetBlob/NetBlob.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddRef()

 Adds a reference. A blob is created with reference count zero. Iris/ReplicationSystem/NetBlob/NetBlob.h  

TArrayView< const FNetObjectReference > CallGetNetObjectReferenceExports()

 Retrieve the object references that need to be exported. Iris/ReplicationSystem/NetBlob/NetBlob.h  

TArrayView< const FNetToken > CallGetNetTokenExports()

 Retrieve NetToken that needs to be exported. Iris/ReplicationSystem/NetBlob/NetBlob.h  

void CollectObjectReferences ( FNetSerializationContext& Context,
FNetReferenceCollector& Collector
) const

 Collect object references from quantized data Iris/ReplicationSystem/NetBlob/NetBlob.h  

virtual void Deserialize ( FNetSerializationContext& Context
)

 Deserialize a blob that was serialized with Serialize. Iris/ReplicationSystem/NetBlob/NetBlob.h  

virtual void DeserializeWithObject ( FNetSerializationContext& Context,
FNetRefHandle RefHandle
)

 Deserialize a blob that was serialized with SerializeWithObject. Iris/ReplicationSystem/NetBlob/NetBlob.h  

const FNetBlobCreationInfo & GetCreationInfo()

 Returns the FNetBlobCreationInfo. Iris/ReplicationSystem/NetBlob/NetBlob.h  

int32 GetRefCount()

 Returns the reference count. A blob is created with reference count zero. Iris/ReplicationSystem/NetBlob/NetBlob.h  
Returns the FReplicationStateDescriptor if there is one. Iris/ReplicationSystem/NetBlob/NetBlob.h  

bool HasExports()

 Returns true if the blob has additional exports to add. Iris/ReplicationSystem/NetBlob/NetBlob.h  

bool IsReliable()

 Whether the blob is reliably sent or not. Iris/ReplicationSystem/NetBlob/NetBlob.h  

void Release ()

 Removes a reference. Iris/ReplicationSystem/NetBlob/NetBlob.h  

virtual void Serialize ( FNetSerializationContext& Context
) const

 Serialize the blob. Iris/ReplicationSystem/NetBlob/NetBlob.h  

virtual void SerializeWithObject ( FNetSerializationContext& Context,
FNetRefHandle RefHandle
) const

 Serialize the blob together with/targeting a specific object knowing the NetHandle has already been serialized. Iris/ReplicationSystem/NetBlob/NetBlob.h  

void SetState ( const TRefCountPtr< const FReplicationStateDescriptor >& BlobDescriptor,
FQuantizedBlobState&& QuantizedBlobState
)

 Set the blob state. Iris/ReplicationSystem/NetBlob/NetBlob.h  

Protected

Name Remarks Include Path Unreal Specifiers

void DeserializeBlob ( FNetSerializationContext& Context
)

 Deserializes the state if there's a valid descriptor and state buffer. Iris/ReplicationSystem/NetBlob/NetBlob.h  

virtual TArrayView< const FNetObjectReference > GetNetObjectReferenceExports()

 Override to return the object references that need to be exported. Iris/ReplicationSystem/NetBlob/NetBlob.h  

virtual TArrayView< const FNetToken > GetNetTokenExports()

 Override to return NetTokenExports that need to be exported, mostly relevant for pre-serialized blobs. Iris/ReplicationSystem/NetBlob/NetBlob.h  

void SerializeBlob ( FNetSerializationContext& Context
) const

 Serializes the state if there's a valid descriptor and state buffer. Iris/ReplicationSystem/NetBlob/NetBlob.h  

Static

Name Remarks Include Path Unreal Specifiers

static void DeserializeCreationInfo ( FNetSerializationContext& Context,
FNetBlobCreationInfo& OutCreationInfo
)

 Deserializes the necessary parts of the creation info so that the correct blob can be created. Iris/ReplicationSystem/NetBlob/NetBlob.h  

static void SerializeCreationInfo ( FNetSerializationContext& Context,
const FNetBlobCreationInfo& CreationInfo
)

 Serializes the necessary parts of the creation info so that the blob can be recreated on the receiving side. Iris/ReplicationSystem/NetBlob/NetBlob.h  

Operators

Name Remarks Include Path Unreal Specifiers

FNetBlob & operator= ( const FNetBlob&
)

   Iris/ReplicationSystem/NetBlob/NetBlob.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page