ReplicationConditionals.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Containers/Array.h"
#include "Containers/Map.h"
#include "Iris/ReplicationSystem/NetObjectGroupHandle.h"
#include "Net/Core/NetBitArray.h"
 
enum ELifetimeCondition : int;
namespace UE::Net
{
    enum class EReplicationCondition : uint32;
    struct FReplicationProtocol;
    namespace Private
    {
        class FDeltaCompressionBaselineInvalidationTracker;
        typedef uint32 FInternalNetRefIndex;
        class FNetRefHandleManager;
        class FReplicationConnections;
        class FNetObjectGroups;
        class FReplicationFiltering;
        class FNetObjectGroups;
    }
}
 
namespace UE::Net::Private
{
 
struct FReplicationConditionalsInitParams
{
    const FNetRefHandleManager* NetRefHandleManager = nullptr;
    const FReplicationFiltering* ReplicationFiltering = nullptr;
    FReplicationConnections* ReplicationConnections = nullptr;
    const FNetObjectGroups* NetObjectGroups = nullptr;
    FDeltaCompressionBaselineInvalidationTracker* BaselineInvalidationTracker = nullptr;
    FInternalNetRefIndex MaxInternalNetRefIndex = 0;
    uint32 MaxConnectionCount = 0;
};
 
class FReplicationConditionals
{
public:
    FReplicationConditionals();
 
    void Init(FReplicationConditionalsInitParams& Params);
 
    void OnMaxInternalNetRefIndexIncreased(FInternalNetRefIndex NewMaxInternalIndex);
 
    void OnInternalNetRefIndicesFreed(const TConstArrayView<FInternalNetRefIndex>& FreedIndices);
 
    void AddConnection(uint32 ConnectionId);
    void RemoveConnection(uint32 ConnectionId);
 
    bool SetConditionConnectionFilter(FInternalNetRefIndex ObjectIndex, EReplicationCondition Condition, uint32 ConnectionId, bool bEnable);
    bool SetCondition(FInternalNetRefIndex ObjectIndex, EReplicationCondition Condition, bool bEnable);
    void SetOwningConnection(FInternalNetRefIndex ObjectIndex, uint32 ConnectionId);
 
    // For property custom conditions only
    void InitPropertyCustomConditions(FInternalNetRefIndex ObjectIndex);
    bool SetPropertyCustomCondition(FInternalNetRefIndex ObjectIndex, const void* Owner, uint16 RepIndex, bool bIsActive);
    bool SetPropertyDynamicCondition(FInternalNetRefIndex ObjectIndex, const void* Owner, uint16 RepIndex, ELifetimeCondition Condition);
 
    void MarkLifeTimeConditionalsDirtyForObjectsInGroup(FNetObjectGroupHandle GroupHandle);
    
    void MarkPropertyDirty(FInternalNetRefIndex ObjectIndex, uint16 RepIndex);
 
    void Update();
 
    struct FConditionalsMask
    {
        bool IsUninitialized() const { return ConditionalsMask == 0; }
        bool IsConditionEnabled(int Condition) const { checkSlow(Condition < 16); return ConditionalsMask & (uint16(1) << unsigned(Condition)); }
        bool SetConditionEnabled(int Condition, bool bEnabled) { checkSlow(Condition < 16); return ConditionalsMask |= (uint16(bEnabled ? 1 : 0) << unsigned(Condition)); }
 
        // Each LifetimeCondition is represented in this member via (1U << ELifetimeCondition)
        uint16 ConditionalsMask;
    };
 
    bool ApplyConditionalsToChangeMask(uint32 ReplicatingConnectionId, bool bIsInitialState, FInternalNetRefIndex ParentObjectIndex, FInternalNetRefIndex ObjectIndex, uint32* ChangeMaskData, const uint32* ConditionalChangeMaskData, const FReplicationProtocol* Protocol);
 
    using FSubObjectsToReplicateArray = TArray<FInternalNetRefIndex, TInlineAllocator<32>>;
    void GetSubObjectsToReplicate(uint32 ReplicationConnectionId, FInternalNetRefIndex ParentObjectIndex, FSubObjectsToReplicateArray& OutSubObjectsToReplicate);
 
private:
    struct FPerObjectInfo
    {
        // Assume there can only be one connection which has the role autonomous connection and all else are simulated
        uint16 AutonomousConnectionId : 15;
        uint16 bRepPhysics : 1;
    };
 
    struct FPerConnectionInfo
    {
        TArray<FConditionalsMask> ObjectConditionals;
    };
 
    struct FSubObjectConditionInfo
    {
        // This is a more compact storage form of ELifetimeCondition
        int8 Condition;
    };
 
    struct FObjectDynamicConditions
    {
        // RepIndex and ELifetimeCondition expressed as int16
        TMap<uint16, int16> DynamicConditions;
    };
 
private:
    void UpdateAndResetObjectsWithDirtyConditionals();
 
    FConditionalsMask GetLifetimeConditionals(uint32 ReplicatingConnectionId, FInternalNetRefIndex ParentObjectIndex, bool bInitialState) const;
 
    FPerObjectInfo* GetPerObjectInfo(FInternalNetRefIndex ObjectIndex);
    const FPerObjectInfo* GetPerObjectInfo(FInternalNetRefIndex ObjectIndex) const;
    void ClearPerObjectInfo(FInternalNetRefIndex ObjectIndex);
    void ClearConnectionInfosForObject(const FNetBitArray& ValidConnections, FInternalNetRefIndex ObjectIndex);
 
    void GetChildSubObjectsToReplicate(uint32 ReplicatingConnectionId, const FConditionalsMask& LifetimeConditionals, const FInternalNetRefIndex ParentObjectIndex, FSubObjectsToReplicateArray& OutSubObjectsToReplicate);
 
    ELifetimeCondition GetDynamicCondition(FInternalNetRefIndex ObjectIndex, uint16 RepIndex) const;
    void SetDynamicCondition(FInternalNetRefIndex ObjectIndex, uint16 RepIndex, ELifetimeCondition Condition);
    bool DynamicConditionChangeRequiresBaselineInvalidation(ELifetimeCondition OldCondition, ELifetimeCondition NewCondition) const;
 
    void MarkRemoteRoleDirty(FInternalNetRefIndex ObjectIndex);
    uint16 GetRemoteRoleRepIndex(const FReplicationProtocol* Protocol);
 
    // Invalidates baselines for root object and subobjects with lifetime conditionals.
    void InvalidateBaselinesForObjectHierarchy(uint32 ObjectIndex, const TConstArrayView<uint32>& ConnectionsToInvalidate);
 
private:
    static constexpr uint16 InvalidRepIndex = 65535U;
 
    const FNetRefHandleManager* NetRefHandleManager = nullptr;
    const FReplicationFiltering* ReplicationFiltering = nullptr;
    FReplicationConnections* ReplicationConnections = nullptr;
    FDeltaCompressionBaselineInvalidationTracker* BaselineInvalidationTracker = nullptr;
    const FNetObjectGroups* NetObjectGroups = nullptr;
 
    TArray<FPerObjectInfo> PerObjectInfos;
    TArray<FPerConnectionInfo> ConnectionInfos;
    TMap<FInternalNetRefIndex, FObjectDynamicConditions> DynamicConditions;
    FNetBitArray ObjectsWithDirtyLifetimeConditionals;
 
    FInternalNetRefIndex MaxInternalNetRefIndex = 0;
    uint32 MaxConnectionCount = 0;
    uint16 CachedRemoteRoleRepIndex = InvalidRepIndex;
};
 
inline FReplicationConditionals::FPerObjectInfo* FReplicationConditionals::GetPerObjectInfo(FInternalNetRefIndex ObjectIndex)
{
    return PerObjectInfos.GetData() + ObjectIndex;
}
 
inline const FReplicationConditionals::FPerObjectInfo* FReplicationConditionals::GetPerObjectInfo(FInternalNetRefIndex ObjectIndex) const
{
    return PerObjectInfos.GetData() + ObjectIndex;
}
 
}