o2::framework::GUIWebSocketHandler Struct Reference

An handler for a websocket message stream. More...

Inherits o2::framework::WebSocketHandler.

Public Member Functions
	GUIWebSocketHandler (DriverServerContext &context, GuiRenderer *renderer)
	~GUIWebSocketHandler () override
void	headers (std::map< std::string, std::string > const &headers) override
	Invoked when all the headers are received.
void	beginFragmentation () override
	FIXME: not implemented.
void	frame (char const *frame, size_t s) override
void	endFragmentation () override
	FIXME: not implemented.
void	control (char const *frame, size_t s) override
	FIXME: not implemented.
void	beginChunk () override
	Invoked before processing the next round of input.
void	endChunk () override
	Invoked whenever we have no more input to process.
Public Member Functions inherited from o2::framework::WebSocketHandler
virtual	~WebSocketHandler ()=default

Public Attributes
DriverServerContext &	mContext
GuiRenderer *	mRenderer
Public Attributes inherited from o2::framework::WebSocketHandler
size_t	remainingSize = 0
	Bytes which are still to be received for the previous, half delivered frame.
size_t	pendingSize = 0
	Bytes which are already there from the previous, half delivered frame.
char *	pendingBuffer = nullptr
	A buffer large enough to contain the next frame to be processed.
size_t	pendingHeaderSize = 0
	Bytes from an incomplete header.
char *	pendingHeader = nullptr

Detailed Description

An handler for a websocket message stream.

Definition at line 108 of file DPLWebSocket.cxx.

Constructor & Destructor Documentation

GUIWebSocketHandler()

o2::framework::GUIWebSocketHandler::GUIWebSocketHandler ( DriverServerContext &  context, GuiRenderer *  renderer  )

inline

Definition at line 109 of file DPLWebSocket.cxx.

~GUIWebSocketHandler()

o2::framework::GUIWebSocketHandler::~GUIWebSocketHandler ( )

inlineoverride

Definition at line 113 of file DPLWebSocket.cxx.

Member Function Documentation

beginChunk()

void o2::framework::GUIWebSocketHandler::beginChunk ( )

inlineoverridevirtual

Invoked before processing the next round of input.

Reimplemented from o2::framework::WebSocketHandler.

Definition at line 172 of file DPLWebSocket.cxx.

beginFragmentation()

void o2::framework::GUIWebSocketHandler::beginFragmentation ( )

inlineoverridevirtual

FIXME: not implemented.

Reimplemented from o2::framework::WebSocketHandler.

Definition at line 122 of file DPLWebSocket.cxx.

control()

void o2::framework::GUIWebSocketHandler::control ( char const *  frame, size_t  s  )

inlineoverridevirtual

FIXME: not implemented.

Reimplemented from o2::framework::WebSocketHandler.

Definition at line 171 of file DPLWebSocket.cxx.

endChunk()

void o2::framework::GUIWebSocketHandler::endChunk ( )

inlineoverridevirtual

Invoked whenever we have no more input to process.

Reimplemented from o2::framework::WebSocketHandler.

Definition at line 173 of file DPLWebSocket.cxx.

endFragmentation()

void o2::framework::GUIWebSocketHandler::endFragmentation ( )

inlineoverridevirtual

FIXME: not implemented.

Reimplemented from o2::framework::WebSocketHandler.

Definition at line 170 of file DPLWebSocket.cxx.

frame()

void o2::framework::GUIWebSocketHandler::frame ( char const *  frame, size_t  s  )

inlineoverridevirtual

Invoked when a frame it's parsed. Notice you do not own the data and you must not free the memory.

Reimplemented from o2::framework::WebSocketHandler.

Definition at line 123 of file DPLWebSocket.cxx.

headers()

void o2::framework::GUIWebSocketHandler::headers ( std::map< std::string, std::string > const &  headers )

inlineoverridevirtual

Invoked when all the headers are received.

Reimplemented from o2::framework::WebSocketHandler.

Definition at line 121 of file DPLWebSocket.cxx.

Member Data Documentation

mContext

DriverServerContext& o2::framework::GUIWebSocketHandler::mContext

The driver context were we want to accumulate changes which we got from the websocket.

Definition at line 177 of file DPLWebSocket.cxx.

mRenderer

GuiRenderer* o2::framework::GUIWebSocketHandler::mRenderer

Definition at line 178 of file DPLWebSocket.cxx.

---

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

• /home/runner/work/AliceO2/AliceO2/Framework/Core/src/DPLWebSocket.cxx