Navigation
API > API/Runtime > API/Runtime/WebSocketServer
Handle to a single connected WebSocket client. May be held past disconnection; SendText/Close are no-ops after disconnect. All methods are thread-safe.
| Name | IWebSocketClientConnection |
| Type | class |
| Header File | /Engine/Source/Runtime/Online/WebSocketServer/Public/IWebSocketClientConnection.h |
| Include Path | #include "IWebSocketClientConnection.h" |
Syntax
class IWebSocketClientConnection
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IWebSocketClientConnection() |
IWebSocketClientConnection.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Close
(
int32 Code, |
Initiate a graceful close with the given status code. | IWebSocketClientConnection.h | |
FString GetPath() |
The URL path from the HTTP Upgrade request (e.g. "/webtests/websocketstests/echo/"). | IWebSocketClientConnection.h | |
void SendText
(
const FString& Message |
Send a UTF-8 text frame to this client. | IWebSocketClientConnection.h |