Websocket Client. More...
#include <WebsocketClient.h>
Public Member Functions | |
WebsocketClient () | |
WebsocketClient (HttpConnection *connection) | |
HttpConnection * | getHttpConnection () |
bool | connect (const Url &url) |
Connects websocket client to server. More... | |
void | sendPing (const String &payload=nullptr) |
Send websocket ping to server. More... | |
void | sendPong (const String &payload=nullptr) |
Send websocket ping to server. More... | |
void | setSslInitHandler (Ssl::Session::InitDelegate handler) |
Set the SSL session initialisation callback. More... | |
void | disconnect () |
Disconnects websocket client from server. More... | |
Protected Member Functions | |
int | verifyKey (HttpConnection &connection, HttpResponse &response) |
bool | bind (HttpRequest &request, HttpResponse &response) |
Binds websocket connection to an http server connection. More... | |
virtual void | send (const char *message, size_t length, ws_frame_type_t type=WS_FRAME_TEXT) |
Sends a websocket message from a buffer. More... | |
void | send (const String &message, ws_frame_type_t type=WS_FRAME_TEXT) |
Sends websocket message from a String. More... | |
void | sendString (const String &message) |
Sends a string websocket message. More... | |
void | sendBinary (const uint8_t *data, size_t length) |
Sends a binary websocket message. More... | |
void | close () |
Closes a websocket connection (without closing the underlying http connection. More... | |
void | reset () |
Resets a websocket connection. More... | |
void | setUserData (void *userData) |
Attaches a user data to a websocket connection. More... | |
void * | getUserData () |
Retrieves user data attached. More... | |
bool | operator== (const WebsocketConnection &rhs) const |
Test if another connection refers to the same object. More... | |
void | setConnectionHandler (WebsocketDelegate handler) |
Sets the callback handler to be called after successful websocket connection. More... | |
void | setMessageHandler (WebsocketMessageDelegate handler) |
Sets the callback handler to be called after a websocket message is received. More... | |
void | setBinaryHandler (WebsocketBinaryDelegate handler) |
Sets the callback handler to be called after a binary websocket message is received. More... | |
void | setDisconnectionHandler (WebsocketDelegate handler) |
Sets the callback handler to be called before closing a websocket connection. More... | |
void | activate () |
Should be called after a websocket connection is established to activate the websocket parser and allow sending of websocket data. More... | |
bool | onConnected () |
Call this method when the websocket connection was (re)activated. More... | |
HttpConnection * | getConnection () |
Gets the underlying HTTP connection. More... | |
void | setConnection (HttpConnection *connection, bool isClientConnection=true) |
Sets the underlying (transport ) HTTP connection. More... | |
WsConnectionState | getState () |
Gets the state of the websocket connection. More... | |
bool | processFrame (TcpClient &client, char *at, int size) |
Callback handler to process a received TCP data frame. More... | |
size_t | encodeFrame (ws_frame_type_t type, const char *inData, size_t inLength, char *outData, size_t outLength, bool useMask=true, bool isFin=true) |
Encode user content into a valid websocket frame. More... | |
Static Protected Member Functions | |
static void | broadcast (const char *message, size_t length, ws_frame_type_t type=WS_FRAME_TEXT) |
Broadcasts a message to all active websocket connections. More... | |
static void | broadcast (const String &message, ws_frame_type_t type=WS_FRAME_TEXT) |
Broadcasts a message to all active websocket connections. More... | |
static const WebsocketList & | getActiveWebsockets () |
Obtain the list of active websockets. More... | |
static int | staticOnDataBegin (void *userData, ws_frame_type_t type) |
static int | staticOnDataPayload (void *userData, const char *at, size_t length) |
static int | staticOnDataEnd (void *userData) |
static int | staticOnControlBegin (void *userData, ws_frame_type_t type) |
static int | staticOnControlPayload (void *userData, const char *, size_t length) |
static int | staticOnControlEnd (void *userData) |
Protected Attributes | |
WebsocketDelegate | wsConnect = nullptr |
WebsocketMessageDelegate | wsMessage = nullptr |
WebsocketBinaryDelegate | wsBinary = nullptr |
WebsocketDelegate | wsDisconnect = nullptr |
void * | userData = nullptr |
WsConnectionState | state = eWSCS_Ready |
Detailed Description
Websocket Client.
Constructor & Destructor Documentation
◆ WebsocketClient() [1/2]
|
inline |
◆ WebsocketClient() [2/2]
|
inline |
Member Function Documentation
◆ activate()
|
inherited |
Should be called after a websocket connection is established to activate the websocket parser and allow sending of websocket data.
◆ bind()
|
inherited |
Binds websocket connection to an http server connection.
- Parameters
-
request response
- Return values
-
bool true on success, false otherwise
◆ broadcast() [1/2]
|
staticinherited |
Broadcasts a message to all active websocket connections.
- Parameters
-
message length type
◆ broadcast() [2/2]
|
inlinestaticinherited |
Broadcasts a message to all active websocket connections.
- Parameters
-
message type
◆ close()
|
inherited |
Closes a websocket connection (without closing the underlying http connection.
◆ connect()
Connects websocket client to server.
- Parameters
-
url Url address of websocket server
◆ disconnect()
|
inline |
Disconnects websocket client from server.
- Deprecated:
- Use
close()
instead
◆ encodeFrame()
|
protectedinherited |
Encode user content into a valid websocket frame.
- Parameters
-
type inData inLength outData outLength useMask MUST be true for client connections isFin true if this is the final frame
- Return values
-
size_t Size of encoded frame
◆ getActiveWebsockets()
|
inlinestaticinherited |
Obtain the list of active websockets.
- Return values
-
const WebsocketList&
- Note
- Return value is const as only restricted operations should be carried out on the list.
◆ getConnection()
|
inlineinherited |
Gets the underlying HTTP connection.
- Return values
-
HttpConnection*
◆ getHttpConnection()
HttpConnection* WebsocketClient::getHttpConnection | ( | ) |
◆ getState()
|
inlineinherited |
Gets the state of the websocket connection.
- Return values
-
WsConnectionState
◆ getUserData()
|
inlineinherited |
Retrieves user data attached.
- Return values
-
void* The user data previously set by setUserData()
◆ onConnected()
|
inherited |
Call this method when the websocket connection was (re)activated.
- Return values
-
bool true on success
◆ operator==()
|
inlineinherited |
Test if another connection refers to the same object.
- Parameters
-
rhs The other WebsocketConnection to compare with
- Return values
-
bool
◆ processFrame()
|
protectedinherited |
Callback handler to process a received TCP data frame.
- Parameters
-
client at size
- Return values
-
bool true if data parsing successful
◆ reset()
|
inherited |
Resets a websocket connection.
◆ send() [1/2]
|
virtualinherited |
Sends a websocket message from a buffer.
- Parameters
-
message length Quantity of data in message type
◆ send() [2/2]
|
inlineinherited |
◆ sendBinary()
|
inlineinherited |
Sends a binary websocket message.
- Parameters
-
data length
◆ sendPing()
|
inline |
Send websocket ping to server.
- Parameters
-
payload Maximum 255 bytes
- Return values
-
bool true if the data can be send, false otherwise
◆ sendPong()
|
inline |
Send websocket ping to server.
- Parameters
-
payload Maximum 255 bytes
- Return values
-
bool true if the data can be send, false otherwise
◆ sendString()
|
inlineinherited |
Sends a string websocket message.
- Parameters
-
message
◆ setBinaryHandler()
|
inlineinherited |
Sets the callback handler to be called after a binary websocket message is received.
- Parameters
-
handler
◆ setConnection()
|
inlineinherited |
Sets the underlying (transport ) HTTP connection.
- Parameters
-
connection the transport connection isClientConnection true when the passed connection is an http client conneciton
◆ setConnectionHandler()
|
inlineinherited |
Sets the callback handler to be called after successful websocket connection.
- Parameters
-
handler
◆ setDisconnectionHandler()
|
inlineinherited |
Sets the callback handler to be called before closing a websocket connection.
- Parameters
-
handler
◆ setMessageHandler()
|
inlineinherited |
Sets the callback handler to be called after a websocket message is received.
- Parameters
-
handler
◆ setSslInitHandler()
|
inline |
Set the SSL session initialisation callback.
- Parameters
-
handler
◆ setUserData()
|
inlineinherited |
Attaches a user data to a websocket connection.
- Parameters
-
userData
◆ staticOnControlBegin()
|
staticprotectedinherited |
◆ staticOnControlEnd()
|
staticprotectedinherited |
◆ staticOnControlPayload()
|
staticprotectedinherited |
◆ staticOnDataBegin()
|
staticprotectedinherited |
◆ staticOnDataEnd()
|
staticprotectedinherited |
◆ staticOnDataPayload()
|
staticprotectedinherited |
◆ verifyKey()
|
protected |
Member Data Documentation
◆ state
|
protectedinherited |
◆ userData
|
protectedinherited |
◆ wsBinary
|
protectedinherited |
◆ wsConnect
|
protectedinherited |
◆ wsDisconnect
|
protectedinherited |
◆ wsMessage
|
protectedinherited |
The documentation for this class was generated from the following file: