LwsWebSocketsManager.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#if WITH_WEBSOCKETS && WITH_LIBWEBSOCKETS
 
#include "IWebSocketsManager.h"
#include "LwsWebSocket.h"
#include "HAL/Runnable.h"
#include "Misc/SingleThreadRunnable.h"
#include "HAL/ThreadSafeCounter.h"
#include "Containers/Ticker.h"
 
#if PLATFORM_WINDOWS
#   include "Windows/AllowWindowsPlatformTypes.h"
#endif
 
THIRD_PARTY_INCLUDES_START
#include "libwebsockets.h"
THIRD_PARTY_INCLUDES_END
 
#if PLATFORM_WINDOWS
#   include "Windows/HideWindowsPlatformTypes.h"
#endif
 
class FRunnableThread;
 
class FLwsWebSocketsManager
    : public IWebSocketsManager
    , public FRunnable
    , public FSingleThreadRunnable
 
{
public:
    FLwsWebSocketsManager();
 
    static FLwsWebSocketsManager& Get();
 
    void StartProcessingWebSocket(FLwsWebSocket* Socket);
 
    void WakeService();
 
    // IWebSocketsManager
    virtual void InitWebSockets(TArrayView<const FString> Protocols) override;
    virtual void ShutdownWebSockets() override;
    virtual TSharedRef<IWebSocket> CreateWebSocket(const FString& Url, const TArray<FString>& Protocols, const TMap<FString, FString>& UpgradeHeaders) override;
    virtual void UpdateConfigs() override;
 
private:
 
    //~ Begin FRunnable Interface
    virtual bool Init() override;
    virtual uint32 Run() override;
    virtual void Stop() override;
    virtual void Exit() override;
    //~ End FRunnable Interface
    
    // FSingleThreadRunnable
    virtual class FSingleThreadRunnable* GetSingleThreadInterface() override { return this; }
 
    virtual void Tick() override;
 
    // FLwsWebSocketsManager
    bool GameThreadTick(float DeltaTime);
    static int StaticCallbackWrapper(lws* Connection, lws_callback_reasons Reason, void* UserData, void* Data, size_t Length);
    int CallbackWrapper(lws* Connection, lws_callback_reasons Reason, void* UserData, void* Data, size_t Length);
 
#if WITH_SSL
    SSL_CTX* SslContext;
#endif
    lws_context* LwsContext;
    TArray<lws_protocols> LwsProtocols;
 
    TArray<TSharedRef<FLwsWebSocket>> Sockets;
    TArray<FLwsWebSocket*> SocketsTickingOnThread;
    TQueue<FLwsWebSocket*> SocketsToStart;
    TQueue<FLwsWebSocket*> SocketsToStop;
    TArray<FLwsWebSocket*> SocketsDestroyedDuringService;
 
    FTSTicker::FDelegateHandle TickHandle;
 
    FDelegateHandle OnChildEndFramePostForkHandle;
 
    // Thread variables
    FRunnableThread* Thread;
 
    FThreadSafeCounter ExitRequest;
 
#if UE_WEBSOCKETS_PLATFORM_SUPPORT_EVENT_LOOP
    bool bPollService = false;
#else
    bool bPollService = true;
#endif
    
    int32 ServiceTimeoutMs = MAX_int32;
 
    double ThreadTargetFrameTimeInSeconds = 1.0f / 30.0f; // 30Hz;
    double ThreadMinimumSleepTimeInSeconds = 0.0f;
 
    bool bDisableDomainAllowlist = false;
    bool bDisableCertValidation = false;
 
    friend class FLwsWebSocket;
};
 
#endif // WITH_WEBSOCKETS && WITH_LIBWEBSOCKETS