RelayTraceWriter.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#if WITH_CHAOS_VISUAL_DEBUGGER
#include <atomic>
#include "Containers/Array.h"
#include "Containers/SpscQueue.h"
#include "Delegates/Delegate.h"
#include "Serialization/BitWriter.h"
#include "Templates/UniquePtr.h"
 
#pragma once
 
class FBufferArchive;
 
namespace Chaos::VD
{
class FRelayTraceWriter
{
public:
    FRelayTraceWriter();
    ~FRelayTraceWriter();
 
    CHAOSVDRUNTIME_API void SetMaxBytesPerBunch(uint32 MaxBytes);
 
    static bool WriteHelper(UPTRINT WriterHandle, const void* Data, uint32 Size)
    {
        if (!WriterHandle)
        {
            return false;
        }
 
        return reinterpret_cast<FRelayTraceWriter*>(WriterHandle)->Write_Internal(Data, Size);
    }
 
    static void CloseHelper(UPTRINT WriterHandle)
    {
        if (!WriterHandle)
        {
            return;
        }
 
        reinterpret_cast<FRelayTraceWriter*>(WriterHandle)->Close();
    }
 
    CHAOSVDRUNTIME_API TOptional<TUniquePtr<FBufferArchive>> DequeuePendingBunch();
 
    CHAOSVDRUNTIME_API int32 NextPendingBunchSize() const;
 
    bool HasPendingBunches() const
    {
        return PendingBunchesCount > 0;
    }
 
    CHAOSVDRUNTIME_API int64 GetQueuedBytesNum() const;
 
    void Close();
 
    bool IsClosed() const
    {
        return bClosed;
    }
 
    DECLARE_DELEGATE(FNewDataAvailableDelegate)
    FNewDataAvailableDelegate& OnNewDataAvailable()
    {
        return NewDataAvailableDelegate;
    }
 
    private:
 
    FNewDataAvailableDelegate NewDataAvailableDelegate;
 
    TUniquePtr<FBufferArchive> CreateBunch();
 
    bool Write_Internal(const void* Data, uint32 Size);
 
    TSpscQueue<TUniquePtr<FBufferArchive>> PendingBunchesToRelay;
    TUniquePtr<FBufferArchive> CurrentPendingBunch;
    std::atomic<int32> PendingBunchesCount = 0;
    std::atomic<bool> bClosed = false;
    uint32 MaxPendingBytesPerBunch = 0;
    std::atomic<int64> QueuedBytesNum = 0;
};
}
#endif // WITH_CHAOS_VISUAL_DEBUGGER