HubConnection.h

Go to the documentation of this file.

/*
 * MIT License
 *
 * Copyright (c) 2020-2022 Frozen Storm Interactive, Yoann Potinet
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
 
#pragma once
 
#include "CallbackManager.h"
#include "CoreMinimal.h"
#include "IHubConnection.h"
#include "IHubProtocol.h"
#include "Tickable.h"
 
class FConnection;

class FHubConnection : public IHubConnection, FTickableGameObject
{
public:
    static constexpr float PingTimer = 10.0f;

    FHubConnection(const FString& InUrl, const TMap<FString, FString>& InHeaders);

    virtual ~FHubConnection();
 
#pragma region IHubConnection overrides
public:
    virtual void Start() override;

    virtual void Stop() override;

    FORCEINLINE virtual FOnHubConnectedEvent& OnConnected() override
    {
        return OnHubConnectedEvent;
    }

    FORCEINLINE virtual FOnHubConnectionErrorEvent& OnConnectionError() override
    {
        return OnHubConnectionErrorEvent;
    }

    FORCEINLINE virtual FHubConnectionClosedEvent& OnClosed() override
    {
        return OnHubConnectionClosedEvent;
    }

    virtual FOnMethodInvocation& On(const FString& EventName) override;

    virtual FOnMethodCompletion& Invoke(const FString& EventName, const TArray<FSignalRValue>& InArguments = TArray<FSignalRValue>()) override;

    virtual void Send(const FString& InEventName, const TArray<FSignalRValue>& InArguments = TArray<FSignalRValue>()) override;
#pragma endregion IHubConnection overrides
 
#pragma region FTickableGameObject overrides
public:
    virtual void Tick(float DeltaTime) override;

    TStatId GetStatId() const override;

    virtual ETickableTickType GetTickableTickType() const override
    {
        return ETickableTickType::Always;
    }

    virtual bool IsTickable() const override
    {
        return true;
    }

    virtual bool IsTickableInEditor() const override
    {
        return true;
    }

    virtual bool IsTickableWhenPaused() const override
    {
        return true;
    }
#pragma endregion FTickableGameObject overrides
 
protected:
    void ProcessMessage(const FString& InMessageStr);
 
private:
    enum class EConnectionState
    {
        Connecting,
        Connected,
        Disconnecting,
        Disconnected,
    };
    EConnectionState ConnectionState;
 
    void OnConnectionStarted();
    void OnConnectionFailed();
    void OnConnectionError(const FString& /* Error */);
    void OnConnectionClosed(int32 StatusCode, const FString& Reason, bool bWasClean);
 
    void TryReconnectIfNeeded();
 
    void Ping();
    void InvokeHubMethod(const FString& MethodName, const TArray<FSignalRValue>& InArguments, FName CallbackId);
 
    FString Host;
 
    TSharedPtr<IHubProtocol> HubProtocol;
    TSharedPtr<FConnection> Connection;
    TMap<FString, FOnMethodInvocation> InvocationHandlers;
    FCriticalSection InvocationHandlersGuard;
    FCallbackManager CallbackManager;
 
    bool bHandshakeReceived = false;
 
    float TickTimeCounter = 0;
 
    TArray<FString> WaitingCalls;
 
    FOnHubConnectedEvent OnHubConnectedEvent;
    FOnHubConnectionErrorEvent OnHubConnectionErrorEvent;
    FHubConnectionClosedEvent OnHubConnectionClosedEvent;
 
    void SendCloseMessage();
 
    bool bReceivedCloseMessage = false;
    bool bShouldReconnect = false;
};