Navigation
API > API/Runtime > API/Runtime/WebSocketServer
A WebSocket server listening on a single port. Handlers are invoked on the game thread.
| Name | IWebSocketServer |
| Type | class |
| Header File | /Engine/Source/Runtime/Online/WebSocketServer/Public/IWebSocketServer.h |
| Include Path | #include "IWebSocketServer.h" |
Syntax
class IWebSocketServer
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IWebSocketServer() |
IWebSocketServer.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool IsListening() |
Returns true if currently listening. | IWebSocketServer.h | |
void OnConnected
(
FWsConnectedHandler Handler |
Register a handler for new connections. Replaces any previous handler. | IWebSocketServer.h | |
void OnDisconnected
(
FWsDisconnectedHandler Handler |
Register a handler for disconnections. Replaces any previous handler. | IWebSocketServer.h | |
void OnMessage
(
FWsMessageHandler Handler |
Register a handler for incoming text messages. Replaces any previous handler. | IWebSocketServer.h | |
bool StartListening() |
Begin accepting connections. Returns false if binding failed. | IWebSocketServer.h | |
void StopListening() |
Stop accepting new connections and close all existing ones. | IWebSocketServer.h | |
void Tick
(
float DeltaTime |
Called every frame on the game thread to dispatch pending events. | IWebSocketServer.h |