AnalyticsET.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "AnalyticsProviderConfigurationDelegate.h"
#include "Containers/Array.h"
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
#include "HAL/Platform.h"
#include "HAL/PlatformCrt.h"
#include "Interfaces/IAnalyticsProviderModule.h"
#include "Modules/ModuleManager.h"
#include "Templates/SharedPointer.h"
#include "Templates/UnrealTemplate.h"
 
class IAnalyticsProvider;
class IAnalyticsProviderET;
 
class FAnalyticsET : public IAnalyticsProviderModule
{
    //--------------------------------------------------------------------------
    // Module functionality
    //--------------------------------------------------------------------------
public:
    static inline FAnalyticsET& Get()
    {
        return FModuleManager::LoadModuleChecked< FAnalyticsET >( "AnalyticsET" );
    }
 
    //--------------------------------------------------------------------------
    // Configuration functionality
    //--------------------------------------------------------------------------
public:
    struct Config
    {
        FString APIKeyET;
        FString APIServerET;
        FString APIEndpointET;
        FString APIUnixSocketPathET;
        TArray<FString> AltAPIServersET;
        FString AppVersionET;
        bool UseLegacyProtocol = false;
        bool bDropEventsOnFlushFailure = true;
        FString AppEnvironment;
        FString UploadType;
        uint32 RetryLimitCount = 0;
        float FlushIntervalSec = -1.f;
        int32 MaximumPayloadSize = -1;
        int32 PreallocatedPayloadSize = -1;
 
        Config() = default;
        Config(FString InAPIKeyET, FString InAPIServerET, FString InAppVersionET = FString(), bool InUseLegacyProtocol = false, FString InAppEnvironment = FString(), FString InUploadType = FString(), TArray<FString> InAltApiServers = TArray<FString>(), float InFlushIntervalSec = -1.f, int32 InMaximumPayloadSize = -1, int32 InPreallocatedPayloadSize = -1)
            : APIKeyET(MoveTemp(InAPIKeyET))
            , APIServerET(MoveTemp(InAPIServerET))
            , AltAPIServersET(MoveTemp(InAltApiServers))
            , AppVersionET(MoveTemp(InAppVersionET))
            , UseLegacyProtocol(InUseLegacyProtocol)
            , AppEnvironment(MoveTemp(InAppEnvironment))
            , UploadType(MoveTemp(InUploadType))
            , FlushIntervalSec(InFlushIntervalSec)
            , MaximumPayloadSize(InMaximumPayloadSize)
            , PreallocatedPayloadSize(InPreallocatedPayloadSize)
        {}
 
        static FString GetKeyNameForAPIKey() { return TEXT("APIKeyET"); }
        static FString GetKeyNameForAPIServer() { return TEXT("APIServerET"); }
        static FString GetKeyNameForAPIEndpoint() { return TEXT("APIEndpointET"); }
        static FString GetKeyNameForAPIUnixSocketPath() { return TEXT("APIUnixSocketPathET"); }
        static FString GetKeyNameForAppVersion() { return TEXT("AppVersionET"); }
        static FString GetKeyNameForUseLegacyProtocol() { return TEXT("UseLegacyProtocol"); }
        static FString GetKeyNameForAppEnvironment() { return TEXT("AppEnvironment"); }
        static FString GetKeyNameForUploadType() { return TEXT("UploadType"); }
        static FString GetDefaultAppEnvironment() { return TEXT("datacollector-binary"); }
        static FString GetDefaultUploadType() { return TEXT("eteventstream"); }
        static FString GetDefaultAPIEndpoint() { return TEXT("datarouter/api/v1/public/data"); }
    };
 
    //--------------------------------------------------------------------------
    // provider factory functions
    //--------------------------------------------------------------------------
public:
    ANALYTICSET_API virtual TSharedPtr<IAnalyticsProvider> CreateAnalyticsProvider(const FAnalyticsProviderConfigurationDelegate& GetConfigValue) const override;
 
    ANALYTICSET_API virtual TSharedPtr<IAnalyticsProviderET> CreateAnalyticsProviderET(const FAnalyticsProviderConfigurationDelegate& GetConfigValue) const;
 
    
    ANALYTICSET_API virtual TSharedPtr<IAnalyticsProviderET> CreateAnalyticsProvider(const Config& ConfigValues) const;
 
private:
    ANALYTICSET_API virtual void StartupModule() override;
    ANALYTICSET_API virtual void ShutdownModule() override;
};