handy_http_websockets.frame

Defines low-level structs and functions for dealing with WebSocket data frame protocol. Usually, you won't need to use these functions and structs directly, since abstractions are provided by the websocket connection and message structs.

Members

Enums

WebSocketCloseStatusCode enum WebSocketCloseStatusCode: An enumeration of possible closing status codes for websocket connections, as per https://datatracker.ietf.org/doc/html/rfc6455#section-7.4
WebSocketFrameOpcode enum WebSocketFrameOpcode: An enumeration of valid opcodes for websocket data frames. https://datatracker.ietf.org/doc/html/rfc6455#section-5.2

Functions

receiveWebSocketFrame WebSocketFrame receiveWebSocketFrame(S stream): Receives a websocket frame from a byte input stream.
sendWebSocketBinaryFrame void sendWebSocketBinaryFrame(S stream, ubyte[] bytes): Undocumented in source. Be warned that the author may not have intended to support it.
sendWebSocketCloseFrame void sendWebSocketCloseFrame(S stream, WebSocketCloseStatusCode code, string message): Undocumented in source. Be warned that the author may not have intended to support it.
sendWebSocketFrame void sendWebSocketFrame(S stream, WebSocketFrame frame): Sends a websocket frame to a byte output stream.
sendWebSocketPingFrame void sendWebSocketPingFrame(S stream, ubyte[] payload): Undocumented in source. Be warned that the author may not have intended to support it.
sendWebSocketPongFrame void sendWebSocketPongFrame(S stream, ubyte[] pingPayload): Undocumented in source. Be warned that the author may not have intended to support it.
sendWebSocketTextFrame void sendWebSocketTextFrame(S stream, string text): Undocumented in source. Be warned that the author may not have intended to support it.

Structs

WebSocketFrame struct WebSocketFrame: Internal intermediary structure used to hold the results of parsing a websocket frame.

handy_http_websockets modules