Websocket Client

References

How to use

#include "Websockets/WebsocketClient.h"
 
UWSClient* WSClient = NewObject<UWSClient>();

Functions

Set Host

• Set the adress and port of host

Get Socket

• Get socket properties

Set Max Send Buffer Size

• Set max size in bytes of send buffer

Get Max Send Buffer Size

• Get max size in bytes of send buffer

Set Split Package

• If the size of a message exceeds the maximum allowed size for the send buffer, it will be divided into smaller packets before being sent.

Get Split Package

• Get if Split Package is enabled

Send Str

• Send a string message
• Return false if socket is closed or string is empty
• Warning: If you’re using Windows, ensure that you are sending characters compatible with UTF-8

Send Buffer

• Send a buffer message
• Return false if socket is closed or buffer is empty

Send Ping

• Send a ping to websocket server
• Return false if socket is closed

Connect

• Connect to the host
• Return false if its already open

Close

• Close connection

Get Error Code

• Get latest error code

Handshake Functions

Handshake is a http request to contact the server and requesting a WebSocket connection

Set Headers

• Set handshake request headers

Get Header

• Get reference to handshake request headers
• Use this function to append or modify headers

Dataframe Functions

Set RSV1

Use RSV1

Set RSV2

Use RSV2

Set RSV3

Use RSV3

Set Mask

Use Mask

Events

On Connected

• Event triggered when a connection is estabilished

On Bytes Transfered

• Event triggered when socket sent and receive data

On Message Sent

• Event triggered when a message is sent

On Message Received

• Event triggered when a message is received

On Pong Received

• Event triggered when a pong message is received

On Close Notify

• Event triggered when a server send a close notification

On Close

• Event triggered when a connection is closed

On Handshke Fail

• Event triggered if any error occur during handshake.
• Normally, when a handshake error occurs, the socket is automatically closed, triggering the on_close event.

On Error

• Event triggered if any error occur during async process