Navigation
API > API/Runtime > API/Runtime/IrisCore
The DataStreamManager contains all active DataStreams that may serialize data. Calls to the DataStream interface functions will be forwarded to active streams. Which streams will be automatically created or allowed to be manually created need to be configured via UDataStreamDefinitions.
| Name | UDataStreamManager |
| Type | class |
| Header File | /Engine/Source/Runtime/Net/Iris/Public/Iris/DataStream/DataStreamManager.h |
| Include Path | #include "Iris/DataStream/DataStreamManager.h" |
Syntax
UCLASS (Transient, MinimalAPI)
class UDataStreamManager : public UDataStream
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UDataStream → UDataStreamManager
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UDataStreamManager() |
Iris/DataStream/DataStreamManager.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~UDataStreamManager() |
Iris/DataStream/DataStreamManager.h |
Classes
| Name | Remarks |
|---|---|
| FImpl |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Impl | TPimplPtr< FImpl > | Iris/DataStream/DataStreamManager.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CloseStream
(
const FName StreamName |
Request that the dynamic data stream with the given name will be closed after handshake with remote peer. | Iris/DataStream/DataStreamManager.h | |
ECreateDataStreamResult CreateStream
(
const FName StreamName |
Creates a DataStream that has been configured via UDataStreamDefinitions. | Iris/DataStream/DataStreamManager.h | |
UE::Net::Private::FNetExports & GetNetExports() |
Iris/DataStream/DataStreamManager.h | ||
EDataStreamSendStatus GetSendStatus
(
const FName StreamName |
Get the send status of an already created data stream. Returns Pause if the stream isn't created. | Iris/DataStream/DataStreamManager.h | |
const UDataStream * GetStream
(
const FName StreamName |
Gets the data stream with a given name. | Iris/DataStream/DataStreamManager.h | |
UDataStream * GetStream
(
const FName StreamName |
Gets the data stream with a given name. | Iris/DataStream/DataStreamManager.h | |
EDataStreamState GetStreamState
(
const FName StreamName |
Get the current state of a DataStream Returns Invalid if the stream isn't created. | Iris/DataStream/DataStreamManager.h | |
void SetSendStatus
(
const FName StreamName, |
Set the send status of an already created data stream. | Iris/DataStream/DataStreamManager.h |
Overridden from UDataStream
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual EWriteResult BeginWrite
(
const FBeginWriteParameters& Params |
Call BeginWrite on all active data streams. | Iris/DataStream/DataStreamManager.h | |
virtual void Deinit () |
Prepare for destruction. | Iris/DataStream/DataStreamManager.h | |
virtual void EndWrite() |
Call EndWrite on all active data streams. | Iris/DataStream/DataStreamManager.h | |
virtual bool HasAcknowledgedAllReliableData() |
Returns true if calling HasAcknowledgedAllReliableData on all data streams also returns true. | Iris/DataStream/DataStreamManager.h | |
virtual void Init
(
const FInitParameters& InitParams |
Initializes the manager. No data stream can be created by the manager before this. | Iris/DataStream/DataStreamManager.h | |
virtual void ProcessPacketDeliveryStatus
(
UE::Net::EPacketDeliveryStatus Status, |
Called for all data streams that wrote to a packet whose delivery status is now known. | Iris/DataStream/DataStreamManager.h | |
virtual void ReadData
(
UE::Net::FNetSerializationContext& context |
When a packet is received call ReadData on all data streams that wrote something. | Iris/DataStream/DataStreamManager.h | |
virtual void Update
(
const FUpdateParameters& Params |
Called to drive required updates during the ReplicationSystem update calls. | Iris/DataStream/DataStreamManager.h | |
virtual EWriteResult WriteData
(
UE::Net::FNetSerializationContext& context, |
Call WriteData on all active data streams. | Iris/DataStream/DataStreamManager.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void AddReferencedObjects
(
UObject* Object, |
Iris/DataStream/DataStreamManager.h | ||
static bool IsKnownStreamDefinition
(
const FName StreamName |
Returns true of the stream of with the specified name is present in the UDataStreamDefintions | Iris/DataStream/DataStreamManager.h |