You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
0f0464a30e
#rnx #rb none #ROBOMERGE-OWNER: ryan.durand #ROBOMERGE-AUTHOR: ryan.durand #ROBOMERGE-SOURCE: CL 10869210 via CL 10869511 via CL 10869900 #ROBOMERGE-BOT: (v613-10869866) [CL 10870549 by ryan durand in Main branch]
96 lines
2.9 KiB
C++
96 lines
2.9 KiB
C++
// Copyright Epic Games, Inc. All Rights Reserved.
|
|
|
|
#pragma once
|
|
|
|
#include "Modules/ModuleManager.h"
|
|
|
|
#if WITH_WEBSOCKETS
|
|
class IWebSocket;
|
|
class IWebSocketsManager;
|
|
#endif // #if WITH_WEBSOCKETS
|
|
|
|
/**
|
|
* Module for web socket implementations
|
|
*/
|
|
class WEBSOCKETS_API FWebSocketsModule :
|
|
public IModuleInterface
|
|
{
|
|
|
|
public:
|
|
|
|
// FWebSocketModule
|
|
FWebSocketsModule()
|
|
#if WITH_WEBSOCKETS
|
|
: WebSocketsManager(nullptr)
|
|
#endif // #if WITH_WEBSOCKETS
|
|
{
|
|
}
|
|
#if WITH_WEBSOCKETS
|
|
/**
|
|
* Delegate fired when a web socket is created.
|
|
*
|
|
* @param WebSocket Reference to newly created web socket
|
|
* @param Protocols Array of protocols on web socket
|
|
* @param Url Url the web socket is connected to
|
|
*/
|
|
DECLARE_MULTICAST_DELEGATE_ThreeParams(FOnWebSocketCreated, const TSharedPtr<class IWebSocket>& /* WebSocket */, const TArray<FString>& /* Protocols */, const FString& /* Url */);
|
|
FOnWebSocketCreated OnWebSocketCreated;
|
|
#endif // #if WITH_WEBSOCKETS
|
|
|
|
/**
|
|
* Singleton-like access to this module's interface. This is just for convenience!
|
|
* Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.
|
|
*
|
|
* @return Returns singleton instance, loading the module on demand if needed
|
|
*/
|
|
static FWebSocketsModule& Get();
|
|
|
|
#if WITH_WEBSOCKETS
|
|
/**
|
|
* Instantiates a new web socket for the current platform
|
|
*
|
|
* @param Url The URL to which to connect; this should be the URL to which the WebSocket server will respond.
|
|
* @param Protocols a list of protocols the client will handle.
|
|
* @return new IWebSocket instance
|
|
*/
|
|
virtual TSharedRef<IWebSocket> CreateWebSocket(const FString& Url, const TArray<FString>& Protocols, const TMap<FString, FString>& UpgradeHeaders = TMap<FString, FString>());
|
|
|
|
|
|
/**
|
|
* Instantiates a new web socket for the current platform
|
|
*
|
|
* @param Url The URL to which to connect; this should be the URL to which the WebSocket server will respond.
|
|
* @param Protocol an optional sub-protocol. If missing, an empty string is assumed.
|
|
* @return new IWebSocket instance
|
|
*/
|
|
virtual TSharedRef<IWebSocket> CreateWebSocket(const FString& Url, const FString& Protocol = FString(), const TMap<FString, FString>& UpgradeHeaders = TMap<FString, FString>());
|
|
#endif // #if WITH_WEBSOCKETS
|
|
|
|
private:
|
|
static FString BuildUpgradeHeader(const TMap<FString, FString>& Headers);
|
|
|
|
// IModuleInterface
|
|
|
|
/**
|
|
* Called when WebSockets module is loaded
|
|
* Initialize implementation specific parts of WebSockets handling
|
|
*/
|
|
virtual void StartupModule() override;
|
|
|
|
/**
|
|
* Called when WebSockets module is unloaded
|
|
* Shutdown implementation specific parts of WebSockets handling
|
|
*/
|
|
virtual void ShutdownModule() override;
|
|
|
|
#if WITH_WEBSOCKETS
|
|
/** Manages active web sockets */
|
|
IWebSocketsManager* WebSocketsManager;
|
|
friend class FLwsWebSocketsManager;
|
|
friend class FLwsWebSocket;
|
|
#endif // #if WITH_WEBSOCKETS
|
|
|
|
/** singleton for the module while loaded and available */
|
|
static FWebSocketsModule* Singleton;
|
|
};
|