NetObjectPrioritizer.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Iris/Core/NetChunkedArray.h"
#include "Iris/ReplicationSystem/ReplicationView.h"
#include "UObject/ObjectMacros.h"
#include "NetObjectPrioritizer.generated.h"
 
struct FNetObjectPrioritizationInfo;
class UReplicationSystem;
namespace UE::Net
{
    typedef uint32 FNetObjectPrioritizerHandle;
    struct FReplicationInstanceProtocol;
    struct FReplicationProtocol;
    struct FReplicationView;
}
 
namespace UE::Net
{
 
constexpr FNetObjectPrioritizerHandle InvalidNetObjectPrioritizerHandle = ~FNetObjectPrioritizerHandle(0);
 
constexpr FNetObjectPrioritizerHandle DefaultSpatialNetObjectPrioritizerHandle = FNetObjectPrioritizerHandle(0);
 
}
 
struct FNetObjectPrioritizationParams
{
    const uint32* ObjectIndices;
 
    uint32 ObjectCount;
 
    float* Priorities;
 
    const FNetObjectPrioritizationInfo* PrioritizationInfos;
 
    uint32 ConnectionId;
 
    UE::Net::FReplicationView View;
};
 
struct FNetObjectPrePrioritizationParams
{
};
 
struct FNetObjectPostPrioritizationParams
{
};
 
struct alignas(8) FNetObjectPrioritizationInfo
{
    uint16 Data[4];
};
 
UCLASS(Transient, MinimalAPI)
class UNetObjectPrioritizerConfig : public UObject
{
    GENERATED_BODY()
};
 
struct FNetObjectPrioritizerInitParams
{
    TObjectPtr<const UReplicationSystem> ReplicationSystem;
    UNetObjectPrioritizerConfig* Config = nullptr;
    uint32 AbsoluteMaxNetObjectCount = 0;
    uint32 CurrentMaxInternalIndex = 0;
    uint32 MaxConnectionCount = 0;
};
 
struct FNetObjectPrioritizerAddObjectParams
{
    FNetObjectPrioritizationInfo& OutInfo;
 
    const UE::Net::FReplicationInstanceProtocol* InstanceProtocol;
 
    const UE::Net::FReplicationProtocol* Protocol;
 
    const uint8* StateBuffer;
};
 
struct FNetObjectPrioritizerUpdateParams
{
    const uint32* ObjectIndices;
    uint32 ObjectCount;
 
    UE::Net::FReplicationInstanceProtocol const*const* InstanceProtocols;
 
    const UE::Net::TNetChunkedArray<uint8*>* StateBuffers = nullptr;
 
    FNetObjectPrioritizationInfo* PrioritizationInfos;
};
 
UCLASS(Abstract)
class UNetObjectPrioritizer : public UObject
{
    GENERATED_BODY()
 
public:
    virtual void Init(FNetObjectPrioritizerInitParams& Params) PURE_VIRTUAL(Init,)
 
    
    virtual void Deinit() PURE_VIRTUAL(Deinit)
 
    virtual void OnMaxInternalNetRefIndexIncreased(uint32 NewMaxInternalIndex) PURE_VIRTUAL(OnMaxInternalNetRefIndexIncreased);
 
    IRISCORE_API virtual void AddConnection(uint32 ConnectionId);
 
    IRISCORE_API virtual void RemoveConnection(uint32 ConnectionId);
 
    virtual bool AddObject(uint32 ObjectIndex, FNetObjectPrioritizerAddObjectParams& Params) PURE_VIRTUAL(AddObject, return false;)
 
    virtual void RemoveObject(uint32 ObjectIndex, const FNetObjectPrioritizationInfo& Info) PURE_VIRTUAL(RemoveObject,)
 
    virtual void UpdateObjects(FNetObjectPrioritizerUpdateParams&) PURE_VIRTUAL(UpdateObjects,)
 
    IRISCORE_API virtual void PrePrioritize(FNetObjectPrePrioritizationParams&);
 
    virtual void Prioritize(FNetObjectPrioritizationParams&) PURE_VIRTUAL(Prioritize,);
 
    IRISCORE_API virtual void PostPrioritize(FNetObjectPostPrioritizationParams&);
 
protected:
    IRISCORE_API UNetObjectPrioritizer();
};