WebsocketResource Class Reference
Class associated with an open websocket to handle communcations. More...
#include <WebsocketResource.h>
Inheritance diagram for WebsocketResource:
Collaboration diagram for WebsocketResource:
Public Member Functions | |
WebsocketResource () | |
virtual int | checkHeaders (HttpServerConnection &connection, HttpRequest &request, HttpResponse &response) |
void | shutdown (HttpServerConnection &connection) override |
Takes care to cleanup the connection. More... | |
void | setConnectionHandler (WebsocketDelegate handler) |
void | setMessageHandler (WebsocketMessageDelegate handler) |
void | setBinaryHandler (WebsocketBinaryDelegate handler) |
void | setPongHandler (WebsocketDelegate handler) |
void | setDisconnectionHandler (WebsocketDelegate handler) |
![]() | |
virtual | ~HttpResource () |
Protected Member Functions | |
bool | onConnect () |
Protected Attributes | |
WebsocketDelegate | wsConnect = nullptr |
WebsocketMessageDelegate | wsMessage = nullptr |
WebsocketBinaryDelegate | wsBinary = nullptr |
WebsocketDelegate | wsPong = nullptr |
WebsocketDelegate | wsDisconnect = nullptr |
Additional Inherited Members | |
![]() | |
HttpServerConnectionBodyDelegate | onBody = nullptr |
resource wants to process the raw body data More... | |
HttpResourceDelegate | onHeadersComplete = nullptr |
headers are ready More... | |
HttpResourceDelegate | onRequestComplete = nullptr |
request is complete OR upgraded More... | |
HttpServerConnectionUpgradeDelegate | onUpgrade = nullptr |
request is upgraded and raw data is passed to it More... | |
Detailed Description
Class associated with an open websocket to handle communcations.
Constructor & Destructor Documentation
◆ WebsocketResource()
|
inline |
Member Function Documentation
◆ checkHeaders()
|
virtual |
Reimplemented in WsCommandHandlerResource.
◆ onConnect()
|
protected |
◆ setBinaryHandler()
|
inline |
◆ setConnectionHandler()
|
inline |
◆ setDisconnectionHandler()
|
inline |
◆ setMessageHandler()
|
inline |
◆ setPongHandler()
|
inline |
◆ shutdown()
|
overridevirtual |
Takes care to cleanup the connection.
Reimplemented from HttpResource.
Member Data Documentation
◆ wsBinary
|
protected |
◆ wsConnect
|
protected |
◆ wsDisconnect
|
protected |
◆ wsMessage
|
protected |
◆ wsPong
|
protected |
The documentation for this class was generated from the following file: