NetJournal.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/StringFwd.h"
#include "Iris/ReplicationSystem/NetRefHandle.h"
#include "Net/Core/Trace/NetDebugName.h"
 
class UReplicationSystem;
 
#ifndef UE_NET_ENABLE_READ_JOURNAL
#if (UE_BUILD_SHIPPING)
#   define UE_NET_ENABLE_READ_JOURNAL 1
#else
#   define UE_NET_ENABLE_READ_JOURNAL 1
#endif 
#endif
 
#if UE_NET_ENABLE_READ_JOURNAL
    #define UE_ADD_READ_JOURNAL_ENTRY(SerializationContext, Name) SerializationContext.AddReadJournalEntry(Name);
    #define UE_RESET_READ_JOURNAL(SerializationContext) SerializationContext.ResetReadJournal();
#else
    #define UE_ADD_READ_JOURNAL_ENTRY(...)
#define UE_RESET_READ_JOURNAL(...)
#endif
 
namespace UE::Net
{
// Simple journal to track last few entries of read data
class FNetJournal
{
    static constexpr uint32 JournalSize = 32U;
    static constexpr uint32 JournalMask = JournalSize - 1U;
 
public:
    void Reset() { NumEntries = 0U; }
    void AddEntry(const TCHAR* Name, uint32 BitOffset, FNetRefHandle NetRefHandle);
    FString Print(const UReplicationSystem* ReplicationSystem) const;
 
private:
    struct FJournalEntry
    {
        const TCHAR* Name;
        FNetRefHandle NetRefHandle;
        uint32 BitOffset;
    };
    FJournalEntry Entries[JournalSize];
    uint32 NumEntries = 0U;
};
 
inline void FNetJournal::AddEntry(const TCHAR* Name, uint32 BitOffset, FNetRefHandle NetRefHandle)
{ 
    Entries[NumEntries & JournalMask] = FJournalEntry({Name, NetRefHandle, BitOffset});
    ++NumEntries;
}
 
}