UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
IWebSocketsManager Class Referenceabstract

#include <IWebSocketsManager.h>

Public Member Functions

virtual void InitWebSockets (TArrayView< const FString > Protocols)=0
 
virtual void ShutdownWebSockets ()=0
 
virtual TSharedRef< IWebSocket > CreateWebSocket (const FString &Url, const TArray< FString > &Protocols, const TMap< FString, FString > &UpgradeHeaders)=0
 
virtual ~IWebSocketsManager ()=default
 
virtual void UpdateConfigs ()
 

Constructor & Destructor Documentation

◆ ~IWebSocketsManager()

virtual IWebSocketsManager::~IWebSocketsManager ( )
virtualdefault

Virtual destructor

Member Function Documentation

◆ CreateWebSocket()

virtual TSharedRef< IWebSocket > IWebSocketsManager::CreateWebSocket ( const FString &  Url,
const TArray< FString > &  Protocols,
const TMap< FString, FString > &  UpgradeHeaders 
)
pure virtual

Instantiates a new web socket for the current platform

Parameters
UrlThe URL to which to connect; this should be the URL to which the WebSocket server will respond.
Protocolsa list of protocols the client will handle.
Returns
new IWebSocket instance

◆ InitWebSockets()

virtual void IWebSocketsManager::InitWebSockets ( TArrayView< const FString >  Protocols)
pure virtual

Web sockets start-up: call before creating any web sockets

◆ ShutdownWebSockets()

virtual void IWebSocketsManager::ShutdownWebSockets ( )
pure virtual

Web sockets teardown: call at shutdown, in particular after all use of SSL has finished

◆ UpdateConfigs()

virtual void IWebSocketsManager::UpdateConfigs ( )
inlinevirtual

Update configuration. Called when config has been updated and we need to apply any changes.

The documentation for this class was generated from the following file: