Navigation
API > API/Plugins > API/Plugins/WebSocketNetworking
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UNetDriver
- UWebSocketNetDriver
References
| Module | WebSocketNetworking |
| Header | /Engine/Plugins/Experimental/WebSocketNetworking/Source/WebSocketNetworking/Public/WebSocketNetDriver.h |
| Include | #include "WebSocketNetDriver.h" |
Syntax
UCLASS&40;Transient, Config&61;Engine&41;
class UWebSocketNetDriver : public UNetDriver
Variables
| Type | Name | Description | |
|---|---|---|---|
| int32 | WebSocketPort | WebSocket server port | |
| IWebSocketServer * | WebSocketServer | IWebSocketServer |
Constructors
| Type | Name | Description | |
|---|---|---|---|
UWebSocketNetDriver
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
| UWebSocketConnection * | |||
| bool | HandleSocketsCommand
(
const TCHAR* Cmd, |
Exec command handlers | |
| void | Callback Function for New Connection from a client is accepted by this server | ||
| void | Callback Function for when this client Connects to the server |
Overridden from UNetDriver
| Type | Name | Description | |
|---|---|---|---|
| ISocketSubsystem * | Stub implementation because for websockets we don't use any underlying socket sub system. | ||
| bool | InitBase
(
bool bInitAsClient, |
Common initialization between server and client connection setup | |
| bool | InitConnect
(
FNetworkNotify* InNotify, |
Initialize the net driver in client mode | |
| bool | InitListen
(
FNetworkNotify* InNotify, |
Initialize the network driver in server mode (listener) | |
| bool | IsAvailable () |
Returns true if this net driver is valid for the current configuration. | |
| bool | |||
| void | Close socket and Free the memory the OS allocated for this socket | ||
| FString | |||
| void | LowLevelSend
(
TSharedPtr< const FInternetAddr > Address, |
Sends a 'connectionless' (not associated with a UNetConection) packet, to the specified address. | |
| void | TickDispatch
(
float DeltaTime |
Handle time update: read and process packets |