WebsocketClient Class Reference

Websocket Client. More...

#include <WebsocketClient.h>

Inheritance diagram for WebsocketClient:

Collaboration diagram for WebsocketClient:

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)
Protected Member Functions inherited from WebsocketConnection
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...
	WebsocketConnection (HttpConnection *connection, bool isClientConnection=true)
	Constructs a websocket connection on top of http client or server connection. More...
virtual	~WebsocketConnection ()
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	setPongHandler (WebsocketDelegate handler)
	Sets the callback handler to be called when pong reply 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...

Additional Inherited Members
Static Protected Member Functions inherited from WebsocketConnection
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)
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...
Protected Attributes inherited from WebsocketConnection
WebsocketDelegate	wsConnect = nullptr
WebsocketMessageDelegate	wsMessage = nullptr
WebsocketBinaryDelegate	wsBinary = nullptr
WebsocketDelegate	wsPong = nullptr
WebsocketDelegate	wsDisconnect = nullptr
void *	userData = nullptr
WsConnectionState	state = eWSCS_Ready

Detailed Description

Websocket Client.

Constructor & Destructor Documentation

WebsocketClient() [1/2]

WebsocketClient::WebsocketClient ( )

inline

WebsocketClient() [2/2]

WebsocketClient::WebsocketClient ( HttpConnection *  connection )

inline

Member Function Documentation

connect()

bool WebsocketClient::connect

(

const Url &

url

)

Connects websocket client to server.

Parameters

url	Url address of websocket server

disconnect()

void WebsocketClient::disconnect ( )

inline

Disconnects websocket client from server.

Deprecated:

Use close() instead

getHttpConnection()

HttpConnection* WebsocketClient::getHttpConnection

(

)

sendPing()

void WebsocketClient::sendPing ( const String &  payload = nullptr )

inline

Send websocket ping to server.

Parameters

payload

Maximum 255 bytes

Return values

bool	true if the data can be send, false otherwise

sendPong()

void WebsocketClient::sendPong ( const String &  payload = nullptr )

inline

Send websocket ping to server.

Parameters

payload

Maximum 255 bytes

Return values

bool	true if the data can be send, false otherwise

setSslInitHandler()

void WebsocketClient::setSslInitHandler ( Ssl::Session::InitDelegate  handler )

inline

Set the SSL session initialisation callback.

Parameters

handler

verifyKey()

int WebsocketClient::verifyKey ( HttpConnection &  connection, HttpResponse &  response  )

protected

---

The documentation for this class was generated from the following file:

• WebsocketClient.h