LootLockerPresenceManager.h

Go to the documentation of this file.

// Copyright (c) 2021 LootLocker
 
#pragma once

 
#include "CoreMinimal.h"
#include "UObject/NoExportTypes.h"
#include "Engine/Engine.h"
#include "LootLockerPresenceClient.h"
#include "LootLockerPlayerData.h"
#include "LootLockerPresenceManager.generated.h"
 
// ========================================================================
// FORWARD DECLARATIONS & DELEGATES
// ========================================================================

DECLARE_DELEGATE_FourParams(FLootLockerPresenceConnectionDelegate, const FString&, ELootLockerPresenceConnectionState, ELootLockerPresenceConnectionState, const FString&); // (PlayerUlid, PreviousState, CurrentState, ErrorMessage)

DECLARE_DELEGATE_TwoParams(FLootLockerPresenceCallbackDelegate, bool, const FString&); // (Success, ErrorMessage)
 
// ========================================================================
// CONFIGURATION TYPES
// ========================================================================

USTRUCT(BlueprintType)
struct LOOTLOCKERSDK_API FLootLockerPresenceManagerConfig
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    bool bIsEnabled = true;

    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    bool bAutoConnectEnabled = true;

    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    bool bAutoDisconnectOnFocusChange = true;

    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    bool bEnabledInEditor = true;
};
 
// ========================================================================
// CACHED STATUS UPDATE STRUCTURE
// ========================================================================
USTRUCT()
struct FLootLockerCachedPresenceStatusUpdate
{
    GENERATED_BODY()
 
    
    FString Status;

    TMap<FString, FString> Metadata;
};
 
 
// ========================================================================
// MAIN CLASS
// ========================================================================

UCLASS(BlueprintType)
class LOOTLOCKERSDK_API ULootLockerPresenceManager : public UObject
{
    GENERATED_BODY()
 
public:
    ULootLockerPresenceManager();
 
    // ====================================================================
    // PUBLIC API - MANUAL PRESENCE CONTROL
    // ====================================================================

    void ConnectPresence(const FString& PlayerUlid, const FLootLockerPresenceCallbackDelegate& OnComplete);

    void DisconnectPresence(const FString& PlayerUlid, const FLootLockerPresenceCallbackDelegate& OnComplete);

    void UpdateStatus(const FString& PlayerUlid, const FString& Status, const TMap<FString, FString>& Metadata, const FLootLockerPresenceCallbackDelegate& OnComplete);

    void UpdateSessionToken(const FString& PlayerUlid, const FString& NewToken);
 
    // ====================================================================
    // PUBLIC API - BULK OPERATIONS
    // ====================================================================

    void ConnectPresenceForAllActiveSessions(const FLootLockerPresenceCallbackDelegate& OnComplete);

    void DisconnectAll(const FLootLockerPresenceCallbackDelegate& OnComplete);

    void PauseAllConnections();

    void PauseConnection(const FString& PlayerUlid);

    void ResumeAllConnections();

    void ResumeConnection(const FString& PlayerUlid);

    void GracefullyShutdown();
 
    // ====================================================================
    // PUBLIC API - QUERY & STATUS
    // ====================================================================

    bool IsPresenceActiveForPlayer(const FString& PlayerUlid) const;

    ELootLockerPresenceConnectionState GetPresenceStateForPlayer(const FString& PlayerUlid) const;

    FLootLockerPresenceConnectionStats GetConnectionStatsForPlayer(const FString& PlayerUlid) const;

    TArray<FString> GetConnectedPlayerUlids() const;

    int32 GetActiveConnectionCount() const;
 
    // ====================================================================
    // PUBLIC API - CONFIGURATION
    // ====================================================================

    static bool IsEnabled();

    static void SetEnabled(bool bEnabled);

    static bool IsAutoConnectEnabled();

    static void SetAutoConnectEnabled(bool bEnabled);

    static bool IsPauseOnBackgroundEnabled();

    static void SetPauseOnBackgroundEnabled(bool bEnabled);

    static bool IsEnabledInEditor();

    static void SetEnabledInEditor(bool bEnabled);
 
protected:
    virtual void BeginDestroy() override;
 
private:
    // ====================================================================
    // PRIVATE MEMBERS - CLIENT MANAGEMENT
    // ====================================================================

    UPROPERTY()
    TMap<FString, ULootLockerPresenceClient*> PresenceClients;

    TSet<FString> ConnectingClients;

    TSet<FString> PausedClients;

    mutable FCriticalSection ClientMapLock;
 
    // ====================================================================
    // PRIVATE MEMBERS - CONFIGURATION & STATE
    // ====================================================================

    FLootLockerPresenceManagerConfig Configuration;
 
    TMap<FString , FLootLockerCachedPresenceStatusUpdate> CachedStatusUpdate;
 
    // ====================================================================
    // PRIVATE METHODS - CLIENT LIFECYCLE
    // ====================================================================

    ULootLockerPresenceClient* CreatePresenceClient(const FString& PlayerUlid, const FString& SessionToken);

    void HandleClientConnectionStateChange(const FString& PlayerUlid, ELootLockerPresenceConnectionState OldState, ELootLockerPresenceConnectionState NewState, const FString& ErrorMessage);
 
    // ====================================================================
    // LIFECYCLE EVENT HANDLERS
    // ====================================================================

    UFUNCTION(Category="LootLocker")
    void HandleStartup();

    UFUNCTION(Category="LootLocker")
    void HandleShutdown();

    UFUNCTION(Category="LootLocker")
    void HandleApplicationBackground();

    UFUNCTION(Category="LootLocker")
    void HandleApplicationForeground();
 
    // ====================================================================
    // OTHER EVENT HANDLERS
    // ====================================================================

    UFUNCTION(Category="LootLocker")
    void HandleConfigurationUpdated(const FString& SettingName);
 
    // ====================================================================
    // SINGLETON MANAGEMENT
    // ====================================================================
public:
    static ULootLockerPresenceManager* GetInstance();

    static void Initialize();
    static void Shutdown();
 
    // ====================================================================
    // PUBLIC API - EVENTS
    // ====================================================================

    static void NotifyPlayerActivated(const FString& PlayerUlid);

    static void NotifyPlayerDeactivated(const FString& PlayerUlid);
private:
    static ULootLockerPresenceManager* Instance;

    static FCriticalSection InstanceLock;
};