AnalyticsProviderETEventCache.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "AnalyticsEventAttribute.h"
#include "Containers/Array.h"
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
#include "CoreTypes.h"
#include "HAL/CriticalSection.h"
#include "Misc/DateTime.h"
#include "Misc/ScopeLock.h"
#include "Templates/Function.h"
#include "Templates/UnrealTemplate.h"
 
class FAnalyticsProviderETEventCache
{
public:
    ANALYTICSET_API FAnalyticsProviderETEventCache(int32 MaximumPayloadSize = -1, int32 InPreallocatedPayloadSize = -1);
 
    ANALYTICSET_API void AddToCache(FString EventName, const TArray<FAnalyticsEventAttribute>& Attributes);
    ANALYTICSET_API void AddToCache(FString EventName);
 
    ANALYTICSET_API void SetDefaultAttributes(TArray<FAnalyticsEventAttribute>&& DefaultAttributes);
 
    ANALYTICSET_API TArray<FAnalyticsEventAttribute> GetDefaultAttributes() const;
 
    ANALYTICSET_API int32 GetDefaultAttributeCount() const;
 
    ANALYTICSET_API FAnalyticsEventAttribute GetDefaultAttribute(int32 AttributeIndex) const;
 
    UE_DEPRECATED(4.25, "This method has been deprecated, use FlushCacheUTF8() instead.")
    ANALYTICSET_API FString FlushCache(SIZE_T* OutEventCount = nullptr);
 
    ANALYTICSET_API TArray<uint8> FlushCacheUTF8();
 
    ANALYTICSET_API TArray<uint8> CreateImmediatePayload(const FString& EventName, const TArray<FAnalyticsEventAttribute>& Attributes) const;
 
    ANALYTICSET_API bool CanFlush() const;
 
    ANALYTICSET_API bool HasFlushesQueued() const;
 
    ANALYTICSET_API int GetNumCachedEvents() const;
 
    ANALYTICSET_API void SetPreallocatedPayloadSize(int32 InSetPreallocatedPayloadSize);
 
    ANALYTICSET_API int32 GetSetPreallocatedPayloadSize() const;
 
    friend class Lock;
 
    class Lock
    {
    public:
        UE_NODISCARD_CTOR explicit Lock(FAnalyticsProviderETEventCache& EventCache)
            : ScopedLock(EventCache.CachedEventsCS) {}
 
    private:
        UE::TScopeLock<FTransactionallySafeCriticalSection> ScopedLock;
    };
 
    static ANALYTICSET_API void OnStartupModule();
 
private:
    ANALYTICSET_API void QueueFlush();
 
    ANALYTICSET_API TSharedRef<FAnalyticsProviderETEventCache> CloneForImmediateMode() const;
 
    struct FAnalyticsEventEntry
    {
        FString EventName;
        FDateTime TimeStamp;
        int32 DateOffsetByteOffset;
        int32 EventSizeChars;
        FAnalyticsEventEntry(FString&& InEventName, int32 InDateOffsetByteOffset, int32 InEventSizeChars)
            : EventName(MoveTemp(InEventName))
            , TimeStamp(FDateTime::UtcNow())
            , DateOffsetByteOffset(InDateOffsetByteOffset)
            , EventSizeChars(InEventSizeChars)
        {}
    };
 
    int32 MaximumPayloadSize;
    int32 PreallocatedPayloadSize;
 
    TArray<FAnalyticsEventEntry> CachedEventEntries;
    TArray<uint8> CachedEventUTF8Stream;
    TArray<FAnalyticsEventAttribute> CachedDefaultAttributes;
    TArray<uint8> CachedDefaultAttributeUTF8Stream;
    TArray<TArray<uint8>> FlushQueue;
 
    mutable FTransactionallySafeCriticalSection CachedEventsCS;
};