Expand description
A library for writing extensions for Ratchet.
§Implementations:
§Usage
Implementing an extension requires two traits to be implemented: ExtensionProvider for negotiating the extension during the WebSocket handshake, and Extension (along with its bounds) for using the extension during the session.
§Splitting an extension
If a WebSocket is to be split into its sending and receiving halves then the extension must
implement the SplittableExtension trait and if it is to be reunited then it must implement the
ReunitableExtension. This allows more fine-grained control over the BiLock within the
receiver.
Structs§
- Frame
Header - A frame’s header.
- Header
- Represents a parsed header.
- Header
Map - A set of HTTP headers
- Header
Value - Represents an HTTP header field value.
- RsvBits
- A structure containing the bits that an extension may set high during a session.
Enums§
- OpCode
- A data code for a frame.
Traits§
- Extension
- A negotiated WebSocket extension.
- Extension
Decoder - A per-message frame decoder.
- Extension
Encoder - A per-message frame encoder.
- Extension
Provider - A trait for negotiating an extension during a WebSocket handshake.
- Reunitable
Extension - A trait for permitting a matched encoder and decoder to be reunited into an extension.
- Splittable
Extension - A trait for permitting an extension to be split into its encoder and decoder halves. Allowing for a WebSocket to be split into its sender and receiver halves.