#include <WebsocketConnection.h>

Inheritance diagram for WebsocketConnection:

Collaboration diagram for WebsocketConnection:

Public Member Functions
	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	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...

Static Public 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...

Protected Member Functions
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 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

Constructor & Destructor Documentation

◆ WebsocketConnection()

WebsocketConnection::WebsocketConnection	(	HttpConnection *	connection,
		bool	isClientConnection = `true`
	)

Constructs a websocket connection on top of http client or server connection.

Parameters

connection	the transport connection
isClientConnection	true when the passed connection is an http client conneciton

◆ ~WebsocketConnection()

virtual WebsocketConnection::~WebsocketConnection ( )

inlinevirtual

Member Function Documentation

◆ activate()

void WebsocketConnection::activate ( )

Should be called after a websocket connection is established to activate the websocket parser and allow sending of websocket data.

◆ bind()

bool WebsocketConnection::bind	(	HttpRequest &	request,
		HttpResponse &	response
	)

Binds websocket connection to an http server connection.

Parameters

request
response

Return values

bool	true on success, false otherwise

◆ broadcast() [1/2]

static void WebsocketConnection::broadcast	(	const char *	message,
		size_t	length,
		ws_frame_type_t	type = `WS_FRAME_TEXT`
	)

static

Broadcasts a message to all active websocket connections.

Parameters

message
length
type

◆ broadcast() [2/2]

static void WebsocketConnection::broadcast	(	const String &	message,
		ws_frame_type_t	type = `WS_FRAME_TEXT`
	)

inlinestatic

Broadcasts a message to all active websocket connections.

Parameters

message
type

◆ close()

void WebsocketConnection::close ( )

Closes a websocket connection (without closing the underlying http connection.

◆ encodeFrame()

size_t WebsocketConnection::encodeFrame	(	ws_frame_type_t	type,
		const char *	inData,
		size_t	inLength,
		char *	outData,
		size_t	outLength,
		bool	useMask = `true`,
		bool	isFin = `true`
	)

protected

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()

static const WebsocketList& WebsocketConnection::getActiveWebsockets ( )

inlinestatic

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()

HttpConnection* WebsocketConnection::getConnection ( )

inline

Gets the underlying HTTP connection.

Return values

HttpConnection*

◆ getState()

WsConnectionState WebsocketConnection::getState ( )

inline

Gets the state of the websocket connection.

Return values

WsConnectionState

◆ getUserData()

void* WebsocketConnection::getUserData ( )

inline

Retrieves user data attached.

Return values

void* The user data previously set by setUserData()

◆ onConnected()

bool WebsocketConnection::onConnected ( )

Call this method when the websocket connection was (re)activated.

Return values

bool	true on success

◆ operator==()

bool WebsocketConnection::operator== ( const WebsocketConnection & rhs ) const

inline

Test if another connection refers to the same object.

Parameters

rhs	The other WebsocketConnection to compare with

Return values

bool

◆ processFrame()

bool WebsocketConnection::processFrame	(	TcpClient &	client,
		char *	at,
		int	size
	)

protected

Callback handler to process a received TCP data frame.

Parameters

client
at
size

Return values

bool	true if data parsing successful

◆ reset()

void WebsocketConnection::reset ( )

Resets a websocket connection.

◆ send() [1/2]

virtual void WebsocketConnection::send	(	const char *	message,
		size_t	length,
		ws_frame_type_t	type = `WS_FRAME_TEXT`
	)

virtual

Sends a websocket message from a buffer.

Parameters

message
length	Quantity of data in message
type

◆ send() [2/2]

void WebsocketConnection::send	(	const String &	message,
		ws_frame_type_t	type = `WS_FRAME_TEXT`
	)

inline

Sends websocket message from a String.

Parameters

message	String
type

Note: A String may contain arbitrary data, not just text, so can use this for any frame type

◆ sendBinary()

void WebsocketConnection::sendBinary	(	const uint8_t *	data,
		size_t	length
	)

inline

Sends a binary websocket message.

Parameters

data
length

◆ sendString()

void WebsocketConnection::sendString ( const String & message )

inline

Sends a string websocket message.

Parameters

message

◆ setBinaryHandler()

void WebsocketConnection::setBinaryHandler ( WebsocketBinaryDelegate handler )

inline

Sets the callback handler to be called after a binary websocket message is received.

Parameters

handler

◆ setConnection()

void WebsocketConnection::setConnection	(	HttpConnection *	connection,
		bool	isClientConnection = `true`
	)

inline

Sets the underlying (transport ) HTTP connection.

Parameters

connection	the transport connection
isClientConnection	true when the passed connection is an http client conneciton

◆ setConnectionHandler()

void WebsocketConnection::setConnectionHandler ( WebsocketDelegate handler )

inline

Sets the callback handler to be called after successful websocket connection.

Parameters

handler

◆ setDisconnectionHandler()

void WebsocketConnection::setDisconnectionHandler ( WebsocketDelegate handler )

inline

Sets the callback handler to be called before closing a websocket connection.

Parameters

handler

◆ setMessageHandler()

void WebsocketConnection::setMessageHandler ( WebsocketMessageDelegate handler )

inline

Sets the callback handler to be called after a websocket message is received.

Parameters

handler

◆ setUserData()

void WebsocketConnection::setUserData ( void * userData )

inline

Attaches a user data to a websocket connection.

Parameters

userData

◆ staticOnControlBegin()

static int WebsocketConnection::staticOnControlBegin	(	void *	userData,
		ws_frame_type_t	type
	)

staticprotected

◆ staticOnControlEnd()

static int WebsocketConnection::staticOnControlEnd ( void * userData )

staticprotected

◆ staticOnControlPayload()

static int WebsocketConnection::staticOnControlPayload	(	void *	userData,
		const char *	,
		size_t	length
	)

staticprotected

◆ staticOnDataBegin()

static int WebsocketConnection::staticOnDataBegin	(	void *	userData,
		ws_frame_type_t	type
	)

staticprotected

◆ staticOnDataEnd()

static int WebsocketConnection::staticOnDataEnd ( void * userData )

staticprotected

◆ staticOnDataPayload()

static int WebsocketConnection::staticOnDataPayload	(	void *	userData,
		const char *	at,
		size_t	length
	)

staticprotected

Member Data Documentation

◆ state

WsConnectionState WebsocketConnection::state = eWSCS_Ready

protected

◆ userData

void* WebsocketConnection::userData = nullptr

protected

◆ wsBinary

WebsocketBinaryDelegate WebsocketConnection::wsBinary = nullptr

protected

◆ wsConnect

WebsocketDelegate WebsocketConnection::wsConnect = nullptr

protected

◆ wsDisconnect

WebsocketDelegate WebsocketConnection::wsDisconnect = nullptr

protected

◆ wsMessage

WebsocketMessageDelegate WebsocketConnection::wsMessage = nullptr

protected

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

WebsocketConnection.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ WebsocketConnection()

◆ ~WebsocketConnection()

Member Function Documentation

◆ activate()

◆ bind()

◆ broadcast() [1/2]

◆ broadcast() [2/2]

◆ close()

◆ encodeFrame()

◆ getActiveWebsockets()

◆ getConnection()

◆ getState()

◆ getUserData()

◆ onConnected()

◆ operator==()

◆ processFrame()

◆ reset()

◆ send() [1/2]

◆ send() [2/2]

◆ sendBinary()

◆ sendString()

◆ setBinaryHandler()

◆ setConnection()

◆ setConnectionHandler()

◆ setDisconnectionHandler()

◆ setMessageHandler()

◆ setUserData()

◆ staticOnControlBegin()

◆ staticOnControlEnd()

◆ staticOnControlPayload()

◆ staticOnDataBegin()

◆ staticOnDataEnd()

◆ staticOnDataPayload()

Member Data Documentation

◆ state

◆ userData

◆ wsBinary

◆ wsConnect

◆ wsDisconnect

◆ wsMessage