UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
WebSocketsModule.h
Go to the documentation of this file.
1// Copyright Epic Games, Inc. All Rights Reserved.
2
3#pragma once
4
5#include "Containers/Array.h"
6#include "Containers/Map.h"
12
13#if WITH_WEBSOCKETS
14class IWebSocket;
16#endif // #if WITH_WEBSOCKETS
17
22 public IModuleInterface
23{
24
25public:
26
27 // FWebSocketModule
29#if WITH_WEBSOCKETS
30 : WebSocketsManager(nullptr)
31#endif // #if WITH_WEBSOCKETS
32 {
33 }
34#if WITH_WEBSOCKETS
42 DECLARE_MULTICAST_DELEGATE_ThreeParams(FOnWebSocketCreated, const TSharedPtr<class IWebSocket>& /* WebSocket */, const TArray<FString>& /* Protocols */, const FString& /* Url */);
44#endif // #if WITH_WEBSOCKETS
45
53
54#if WITH_WEBSOCKETS
63
64
72 WEBSOCKETS_API virtual TSharedRef<IWebSocket> CreateWebSocket(const FString& Url, const FString& Protocol = FString(), const TMap<FString, FString>& UpgradeHeaders = TMap<FString, FString>());
73#endif // #if WITH_WEBSOCKETS
74
75private:
76 static WEBSOCKETS_API FString BuildUpgradeHeader(const TMap<FString, FString>& Headers);
77
78 // IModuleInterface
79
84 WEBSOCKETS_API virtual void StartupModule() override;
85
90 WEBSOCKETS_API virtual void ShutdownModule() override;
91
92#if WITH_WEBSOCKETS
95 friend class FLwsWebSocketsManager;
96 friend class FLwsWebSocket;
97
99 void OnConfigSectionsChanged(const FString& IniFilename, const TSet<FString>& SectionNames);
100#endif // #if WITH_WEBSOCKETS
101
103 static WEBSOCKETS_API FWebSocketsModule* Singleton;
104};
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition SharedPointer.h:127
#define DECLARE_MULTICAST_DELEGATE_ThreeParams(DelegateName, Param1Type, Param2Type, Param3Type)
Definition DelegateCombinations.h:67
Definition WebSocketsModule.h:23
static WEBSOCKETS_API FWebSocketsModule & Get()
Definition WebSocketsModule.cpp:77
FWebSocketsModule()
Definition WebSocketsModule.h:28
Definition ModuleInterface.h:14
Definition IWebSocket.h:7
Definition IWebSocketsManager.h:11
Definition Array.h:670
Definition UnrealString.h.inl:34
Definition SharedPointer.h:692
Definition SharedPointer.h:153