SequentialPartialNetBlobHandler.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
#include "Iris/ReplicationSystem/NetBlob/NetBlobHandler.h"
#include "SequentialPartialNetBlobHandler.generated.h"
 
class FNetBlobHandlerManager;
class UReplicationSystem;
class USequentialPartialNetBlobHandlerConfig;
namespace UE::Net
{
    class FNetObjectReference;
}
 
struct FSequentialPartialNetBlobHandlerInitParams
{
    UReplicationSystem* ReplicationSystem;
 
    const USequentialPartialNetBlobHandlerConfig* Config;
};
 
UCLASS(Config=Engine, MinimalAPI)
class USequentialPartialNetBlobHandlerConfig : public UObject
{
    GENERATED_BODY()
 
public:
    uint32 GetMaxPartBitCount() const { return MaxPartBitCount; }
    uint32 GetMaxPartCount() const { return MaxPartCount; }
    uint64 GetTotalMaxPayloadBitCount() const { return GetMaxPartBitCount()*uint64(GetMaxPartCount()); }
 
protected:
    UPROPERTY(Config)
    uint32 MaxPartBitCount = 128*8;
 
    UPROPERTY(Config)
    uint32 MaxPartCount = 4096;
};
 
UCLASS(abstract, MinimalApi, transient)
class USequentialPartialNetBlobHandler : public UNetBlobHandler
{
    GENERATED_BODY()
 
public:
    IRISCORE_API bool SplitNetBlob(UE::Net::FNetSerializationContext& Context, const TRefCountPtr<FNetBlob>& Blob, TArray<TRefCountPtr<FNetBlob>>& OutPartialBlobs, const UE::Net::FNetDebugName* InDebugName = nullptr) const;
 
    IRISCORE_API bool SplitNetBlob(UE::Net::FNetSerializationContext& Context, const UE::Net::FNetObjectReference& NetObjectReference, const TRefCountPtr<FNetBlob>& Blob, TArray<TRefCountPtr<FNetBlob>>& OutPartialBlobs, const UE::Net::FNetDebugName* InDebugName = nullptr) const;
 
protected:
    IRISCORE_API USequentialPartialNetBlobHandler();
 
    IRISCORE_API void Init(const FSequentialPartialNetBlobHandlerInitParams& InitParams);
 
    const USequentialPartialNetBlobHandlerConfig* GetConfig() const { return Config; }
 
    // Convenience
    UReplicationSystem* ReplicationSystem;
 
private:
#if WITH_AUTOMATION_WORKER
    friend class UMockSequentialPartialNetBlobHandler;
#endif
 
    // UNetBlobHandler API. Not exposed to subclasses.
    virtual TRefCountPtr<FNetBlob> CreateNetBlob(const FNetBlobCreationInfo&) const override;
 
    /* A call will result in an error. Either override or use an external NetBlobAssembler instead and forward the final assembled blob to the appropriate handler. */
    virtual void OnNetBlobReceived(UE::Net::FNetSerializationContext& Context, const TRefCountPtr<FNetBlob>& NetBlob) override;
 
    const USequentialPartialNetBlobHandlerConfig* Config;
};