automotive-message-broker  0.14.803
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Public Types | Public Member Functions | Static Public Member Functions | List of all members
WebSockets Class Reference

Encapsulation of the libwebsockets library. More...

#include <websockets.h>

Public Types

enum  Type { Server, Client }
 

Public Member Functions

 WebSockets (WebSocketsObserver &observer, Type t=Server, int port=23001, std::string ip="")
 
 WebSockets (const WebSockets &)=delete
 
WebSocketsoperator= (const WebSockets &)=delete
 
 WebSockets (WebSockets &&)=delete
 
WebSocketsoperator= (WebSockets &&)=delete
 
void addPoll (int fd)
 
void removePoll (int fd)
 
WebSocketsObservergetObserver ()
 
lws_context * getContext ()
 

Static Public Member Functions

static int Write (lws *lws, const std::string &strToWrite)
 

Detailed Description

Encapsulation of the libwebsockets library.

Listens on 23001 port. Calls WebSocketsObserver::dataReceived callback when any data are received.

See Also
libwebsockets

Constructor & Destructor Documentation

WebSockets::WebSockets ( WebSocketsObserver observer,
Type  t = Server,
int  port = 23001,
std::string  ip = "" 
)
Parameters
observerObserver to be called when any data are received.
WebSockets::WebSockets ( const WebSockets )
delete

Copy constructor

WebSockets::WebSockets ( WebSockets &&  )
delete

Move constructor

Member Function Documentation

WebSockets::addPoll ( int  fd)

libwebsocket helper function, called on LWS_CALLBACK_ADD_POLL_FD

Parameters
fdlibwebsocket raw file descriptor
WebSockets::getContext ( )
inline

libwebsocket_context getter

Returns
Pointer to libwebsocket_context
WebSockets::getObserver ( )
inline

WebSocketsObserver getter

Returns
Observer to be called when any data are received
WebSockets& WebSockets::operator= ( const WebSockets )
delete

Copy assignment

Returns
Reference to WebSockets
WebSockets& WebSockets::operator= ( WebSockets &&  )
delete

Move assignment

Returns
Reference to WebSockets
WebSockets::removePoll ( int  fd)

libwebsocket helper function, called on LWS_CALLBACK_DEL_POLL_FD

Parameters
fdlibwebsocket raw file descriptor
WebSockets::Write ( lws *  lws,
const std::string &  strToWrite 
)
static

libwebsocket_write helper function

Parameters
lwslibwebsocket *
strToWriteData to be written.
Returns
Number of the data bytes written.

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