ChunkedDataStream.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Iris/DataStream/DataStream.h"
#include "Iris/Serialization/IrisObjectReferencePackageMap.h"
#include "ChunkedDataStream.generated.h"
 
namespace UE::Net
{
    struct FIrisPackageMapExports;
    namespace Private
    {
        class FChunkedDataWriter;
        class FChunkedDataReader;
    }
}
 
class FChunkedDataStreamExportWriteScope
{
public:
    IRISCORE_API FChunkedDataStreamExportWriteScope(UChunkedDataStream* DataStream);
    IRISCORE_API UIrisObjectReferencePackageMap* GetPackageMap();
 
private:
    UE::Net::FIrisObjectReferencePackageMapWriteScope WriteScope;
};
 
class FChunkedDataStreamExportReadScope
{
public:
    IRISCORE_API FChunkedDataStreamExportReadScope(UChunkedDataStream* DataStream);
    IRISCORE_API UIrisObjectReferencePackageMap* GetPackageMap();
 
private:
    UE::Net::FIrisObjectReferencePackageMapReadScope ReadScope;
};
 
UCLASS(MinimalAPI)
class UChunkedDataStream : public UDataStream
{
    GENERATED_BODY()
 
public:
    enum class EDispatchResult : uint8
    {
        Ok,
        WaitingForMustBeMappedReferences,
        NothingToDispatch
    };
 
    IRISCORE_API bool EnqueuePayload(const TSharedPtr<TArray64<uint8>>& Payload);
 
    IRISCORE_API EDispatchResult DispatchReceivedPayload(TFunctionRef<void(TConstArrayView64<uint8>)> DispatchPayloadFunction);
 
    IRISCORE_API EDispatchResult DispatchReceivedPayloads(TFunctionRef<void(TConstArrayView64<uint8>)> DispatchPayloadFunction);
 
    IRISCORE_API uint32 GetNumReceivedPayloadsPendingDispatch() const;
 
    IRISCORE_API UIrisObjectReferencePackageMap* GetPackageMap();
    IRISCORE_API const UIrisObjectReferencePackageMap* GetPackageMap() const;
 
    IRISCORE_API uint32 GetQueuedByteCount() const;
 
    IRISCORE_API void SetMaxUndispatchedPayloadBytes(uint32 MaxUndispatchedPayloadBytes);
 
    IRISCORE_API void SetMaxEnqueuedPayloadBytes(uint32 MaxEnqueuedPayloadBytes);
 
    IRISCORE_API bool HasError() const;
 
protected:
 
    // UDataStream interface
    IRISCORE_API virtual void Init(const UDataStream::FInitParameters& Params) override;
    IRISCORE_API virtual void Deinit() 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 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;
 
private:
    friend FChunkedDataStreamExportWriteScope;
    friend FChunkedDataStreamExportReadScope;
 
    UE::Net::Private::FChunkedDataWriter* ChunkedWriter = nullptr;
    UE::Net::Private::FChunkedDataReader* ChunkedReader = nullptr;
 
    UPROPERTY(Transient)
    TObjectPtr<UIrisObjectReferencePackageMap> PackageMap = nullptr;
};