DataStreamManager.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "DataStream.h"
#include "Templates/PimplPtr.h"
#include "DataStreamManager.generated.h"
 
enum class EDataStreamSendStatus : uint8;
class UDataStream;
 
enum class ECreateDataStreamResult : uint8
{
    // DataStream was successfully created.
    Success,
    // A DataStream with that name is already created.
    Error_Duplicate,
    // There's no DataStreamDefinition for the requested DataStream.
    Error_MissingDefinition,
    // There's something wrong with the DataStreamDefinition for the requested DataStream.
    Error_InvalidDefinition,
    // There's a fixed limit on how many unique data streams can be created.
    Error_TooManyStreams,
};
 
namespace UE::Net::Private
{
    class FNetExports;
}
 
UCLASS(transient, MinimalApi)
class UDataStreamManager : public UDataStream
{
    GENERATED_BODY()
 
public:
    IRISCORE_API virtual ~UDataStreamManager();
 
    // UDataStream interface
 
    virtual IRISCORE_API void Init(const FInitParameters& InitParams) override;
 
    IRISCORE_API void Deinit();
 
    IRISCORE_API virtual void Update(const FUpdateParameters& Params) override;
 
    IRISCORE_API virtual EWriteResult BeginWrite(const FBeginWriteParameters& Params) override;
 
    IRISCORE_API virtual EWriteResult WriteData(UE::Net::FNetSerializationContext& context, FDataStreamRecord const*& OutRecord) override;
 
    IRISCORE_API virtual void EndWrite() override;
 
    IRISCORE_API virtual void ReadData(UE::Net::FNetSerializationContext& context) override;
 
    IRISCORE_API virtual void ProcessPacketDeliveryStatus(UE::Net::EPacketDeliveryStatus Status, FDataStreamRecord const* Record) override;
 
    IRISCORE_API virtual bool HasAcknowledgedAllReliableData() const override;
 
    // DataStreamManager specifics
 
    IRISCORE_API static bool IsKnownStreamDefinition(const FName StreamName);
 
    IRISCORE_API ECreateDataStreamResult CreateStream(const FName StreamName);
 
    IRISCORE_API const UDataStream* GetStream(const FName StreamName) const;
 
    IRISCORE_API UDataStream* GetStream(const FName StreamName);
 
    IRISCORE_API void CloseStream(const FName StreamName);
 
    IRISCORE_API EDataStreamState GetStreamState(const FName StreamName) const;
 
    IRISCORE_API void SetSendStatus(const FName StreamName, EDataStreamSendStatus Status);
 
    IRISCORE_API EDataStreamSendStatus GetSendStatus(const FName StreamName) const;
 
    UE::Net::Private::FNetExports& GetNetExports();
 
private:
    UDataStreamManager();
 
    static void AddReferencedObjects(UObject* Object, FReferenceCollector& Collector);
 
private:
    class FImpl;
    TPimplPtr<FImpl> Impl;
};