Navigation
API > API/Runtime > API/Runtime/IrisCore
DataStream is an interface that facilitates implementing the replication of custom data, such as bulky data or data with special delivery guarantees.
| Name | UDataStream |
| Type | class |
| Header File | /Engine/Source/Runtime/Net/Iris/Public/Iris/DataStream/DataStream.h |
| Include Path | #include "Iris/DataStream/DataStream.h" |
Syntax
UCLASS (Abstract, MinimalAPI, Transient)
class UDataStream : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UDataStream
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~UDataStream() |
Iris/DataStream/DataStream.h |
Structs
| Name | Remarks |
|---|---|
| FBeginWriteParameters | |
| FInitParameters | |
| FUpdateParameters |
Enums
Public
| Name | Remarks |
|---|---|
| EDataStreamState | |
| EUpdateType | |
| EWriteResult |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DataStreamInitParameters | FInitParameters | Iris/DataStream/DataStream.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual EWriteResult BeginWrite
(
const FBeginWriteParameters& Params |
Called before any calls to potential WriteData, if it returns EWriteData::NoData no other calls will be made. | Iris/DataStream/DataStream.h | |
virtual void Deinit() |
Called when a created stream is destroyed. | Iris/DataStream/DataStream.h | |
virtual void EndWrite() |
Called after the final call to WriteData this frame, allowing the DataStream to cleanup data setup during BeginWrite. | Iris/DataStream/DataStream.h | |
FName GetDataStreamName() |
Get name of DataStream | Iris/DataStream/DataStream.h | |
const UDataStream::EDataStreamState GetState() |
Get the current state of the DataStream. | Iris/DataStream/DataStream.h | |
virtual bool HasAcknowledgedAllReliableData() |
Iris/DataStream/DataStream.h | ||
virtual void Init
(
const FInitParameters& Params |
Called before any other calls are made. | Iris/DataStream/DataStream.h | |
virtual void ProcessPacketDeliveryStatus
(
UE::Net::EPacketDeliveryStatus Status, |
For each packet into which we have written data we are guaranteed to get a call to ProcessPacketDeliveryStatus when it's known whether the packet was delivered or not. | Iris/DataStream/DataStream.h | |
virtual void ReadData
(
UE::Net::FNetSerializationContext& Context |
Deserialize data that was written with WriteData. | Iris/DataStream/DataStream.h | |
void RequestClose () |
Initiate close of DataStream. | Iris/DataStream/DataStream.h | |
virtual void Update
(
const FUpdateParameters& Params |
Called to drive required updates during the ReplicationSystem update calls. | Iris/DataStream/DataStream.h | |
virtual EWriteResult WriteData
(
UE::Net::FNetSerializationContext& Context, |
Serialize data to a bitstream and optionally store record of what was serialized to a custom FDataStreamRecord. | Iris/DataStream/DataStream.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const UDataStream::FInitParameters & GetInitParameters() |
Access init parameters. | Iris/DataStream/DataStream.h |