WebsocketServer Class Reference

#include <websocket_server.h>

Inheritance diagram for WebsocketServer:

Public Member Functions
virtual bool	isDebugPlugin () override
virtual bool	isRunning () const override
	isRunning More...
virtual const char *	name () const override
	Name of the plugin type, NOT the particular instance. More...
virtual void	shutdown () override
	shutdown Stop streaming More...
virtual bool	start (QStringList *) override
	start streaming. More...
	WebsocketServer ()
virtual	~WebsocketServer () override
Public Member Functions inherited from PJ::DataStreamer
PlotDataMapRef &	dataMap ()
const PlotDataMapRef &	dataMap () const
	DataStreamer ()=default
std::mutex &	mutex ()
virtual std::pair< QAction *, int >	notificationAction ()
	Gets the action to execute when clicking the 'notifications' button and the current number of outstanding notifications. More...
const ParserFactories *	parserFactories () const
void	setMaximumRangeX (double range)
void	setParserFactories (ParserFactories *parsers)
virtual	~DataStreamer ()=default
Public Member Functions inherited from PJ::PlotJugglerPlugin
virtual const std::vector< QAction * > &	availableActions ()
virtual QWidget *	optionsWidget ()
	optionsWidget pointer to a persistent widget used to set the plugin options . More...
	PlotJugglerPlugin ()=default
virtual bool	xmlLoadState (const QDomElement &parent_element)
	Override this method to load the status of the plugin from XML. More...
QDomElement	xmlSaveState (QDomDocument &doc) const
virtual bool	xmlSaveState (QDomDocument &doc, QDomElement &parent_element) const
	Override this method to save the status of the plugin to XML. More...

Private Slots
void	onNewConnection ()
void	processMessage (QString message)
void	socketDisconnected ()

Private Attributes
QList< QWebSocket * >	_clients
PJ::MessageParserPtr	_parser
bool	_running
QWebSocketServer	_server

Additional Inherited Members
Signals inherited from PJ::DataStreamer
void	clearBuffers ()
	Request the main application to clear previous data points. More...
void	closed ()
void	dataReceived ()
void	notificationsChanged (int active_notification_count)
void	removeGroup (std::string group_name)
	All the series which share this group, will be deleted. More...

Detailed Description

Definition at line 30 of file websocket_server.h.

Constructor & Destructor Documentation

WebsocketServer()

WebsocketServer::WebsocketServer

(

)

Definition at line 57 of file websocket_server.cpp.

~WebsocketServer()

WebsocketServer::~WebsocketServer ( )

overridevirtual

Definition at line 64 of file websocket_server.cpp.

Member Function Documentation

isDebugPlugin()

virtual bool WebsocketServer::isDebugPlugin ( )

inlineoverridevirtual

Override this to return true, if you want this plugin to be loaded only when the command line option [-t] is used.

Reimplemented from PJ::PlotJugglerPlugin.

Definition at line 55 of file websocket_server.h.

isRunning()

virtual bool WebsocketServer::isRunning ( ) const

inlineoverridevirtual

isRunning

Returns

true if start() called, false after shutwodn()

Implements PJ::DataStreamer.

Definition at line 43 of file websocket_server.h.

name()

virtual const char* WebsocketServer::name ( ) const

inlineoverridevirtual

Name of the plugin type, NOT the particular instance.

Implements PJ::PlotJugglerPlugin.

Definition at line 50 of file websocket_server.h.

onNewConnection

void WebsocketServer::onNewConnection ( )

privateslot

Definition at line 171 of file websocket_server.cpp.

processMessage

void WebsocketServer::processMessage ( QString  message )

privateslot

Definition at line 180 of file websocket_server.cpp.

shutdown()

void WebsocketServer::shutdown ( )

overridevirtual

shutdown Stop streaming

Implements PJ::DataStreamer.

Definition at line 161 of file websocket_server.cpp.

socketDisconnected

void WebsocketServer::socketDisconnected ( )

privateslot

Definition at line 210 of file websocket_server.cpp.

start()

bool WebsocketServer::start ( QStringList *  pre_selected_sources )

overridevirtual

start streaming.

Parameters

optional

list of pre selected sources.

Returns

true if started correctly.

Implements PJ::DataStreamer.

Definition at line 69 of file websocket_server.cpp.

Member Data Documentation

_clients

QList<QWebSocket*> WebsocketServer::_clients

private

Definition at line 62 of file websocket_server.h.

_parser

PJ::MessageParserPtr WebsocketServer::_parser

private

Definition at line 64 of file websocket_server.h.

_running

bool WebsocketServer::_running

private

Definition at line 61 of file websocket_server.h.

_server

QWebSocketServer WebsocketServer::_server

private

Definition at line 63 of file websocket_server.h.

---

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

• websocket_server.h
• websocket_server.cpp