Unreal Engine Plugin
Websocket Client
How to use Websocket client class
References
#include "websocket/wsclient.h"
How to use
Blueprint: search by GetInternetProtocolSubsystem and call CreateWebsocketClient function
C++: Use the code bellow
#include "websocket/wsclient.h"
UWSClient* client = NewObject<UWSClient>();Variables
Handshake
- Set/Get handshake headers.
Handshake
Functions
Functions
Is Open
- Return true if socket is open.
𝑓
Is Open
Return Value
Local Endpoint
- Get the local endpoint of the socket. Use this function only after open connection.
𝑓
Local Endpoint
Return Value
Remote Endpoint
- Get the remote endpoint of the socket. Use this function only after open connection.
𝑓
Remote Endpoint
Return Value
Get Error Code
- Return a struct of the latest error code returned by asio.
𝑓
Get Error Code
Return Value
Write
- Sends string data on the socket.
- It returns false if socket is closed or if buffer is empty.
𝑓
Write
Target is WSClient
Target
Message
Callback
Return Value
On Message Sent
Custom Event
Error Code
Bytes Sent
Write Buffer
- Sends buffer data on the socket.
- It returns false if socket is closed or if buffer is empty.
𝑓
Write Buffer
Target is WSClient
Target
Buffer
Callback
Return Value
On Message Sent
Custom Event
Error Code
Bytes Sent
Ping
- Send a ping message.
- It returns false if socket is closed or if buffer is empty.
𝑓
Ping
Target is WSClient
Target
Callback
Return Value
On Message Sent
Custom Event
Error Code
Bytes Sent
Pong
- Send a pong message.
- It returns false if socket is closed or if buffer is empty.
𝑓
Pong
Target is WSClient
Target
Callback
Return Value
On Message Sent
Custom Event
Error Code
Bytes Sent
Connect
- Listen for datagram messages on a named port and address.
- It returns false if socket is already open or if asio return any error code during the bind.
𝑓
Connect
Target is WSClient
Target
Bind Opts
Return Value
End
- Perform a smooth close of socket following ws protocol and stop listening for data on it. 'on_close' event will be triggered.
𝑓
End
Target is WSClient
Target
Code
Reason
Close
- Close the underlying socket and stop listening for data on it. 'on_close' event will be triggered.
𝑓
Close
Target is WSClient
Target
Code
Reason
Events
On Connected
- Event triggered when a connection is estabilished.
Bind Event to On Connected
Target
Event
On Connected
Custom Event
Handshake
On Unexpected Handshake
- Event triggered when a connection is estabilished.
Bind Event to On Unexpected Handshake
Target
Event
On Unexpected Handshake
Custom Event
Handshake
On Message
- Event triggered when socket send or receive data.
Bind Event to On Message
Target
Event
On Message
Custom Event
Buffer
Is Binary
On Ping
- This event will be triggered when a ping has been received.
Bind Event to On Ping
Target
Event
On Ping
Custom Event
On Pong
- This event will be triggered when a pong has been received.
Bind Event to On Pong
Target
Event
On Pong
Custom Event
On Close
- Event triggered when socket is closed.
Bind Event to On Close
Target
Event
On Close
Custom Event
Code
Reason
On Error
- Event triggered if any error occur during async process.
Bind Event to On Error
Target
Event
On Error
Custom Event
Error Code