handy_httpd.components.websocket.handler

Defines components relating to how websocket messages and initial HTTP requests are handled.

Members

Classes

WebSocketConnection
class WebSocketConnection

All the data that represents a WebSocket connection tracked by the WebSocketHandler.

WebSocketException
class WebSocketException

An exception that's thrown if an unexpected situation arises while dealing with a websocket connection.

WebSocketHandler
class WebSocketHandler

A special HttpRequestHandler implementation that exclusively handles websocket connection handshakes.

WebSocketMessageHandler
class WebSocketMessageHandler

An abstract class that you should extend to define logic for handling websocket messages and events. Create a new class that inherits from this one, and overrides any "on..." methods that you'd like.

Structs

WebSocketBinaryMessage
struct WebSocketBinaryMessage

A binary websocket message.

WebSocketCloseMessage
struct WebSocketCloseMessage

A "close" control websocket message indicating the client is closing the connection.

WebSocketTextMessage
struct WebSocketTextMessage

A text-based websocket message.