Expand description
Async WebSocket support for compio.
This library is an implementation of WebSocket handshakes and streams for compio. It is based on the tungstenite crate which implements all required WebSocket protocol logic. This crate brings compio support / compio integration to it.
Each WebSocket stream implements message reading and writing.
Modules§
Structs§
- WebSocket
Config - The configuration for WebSocket connection.
- WebSocket
Stream
Enums§
- Tungstenite
Error - Possible WebSocket errors.
- WebSocket
Message - An enum representing the various forms of a WebSocket message.
Functions§
- accept_
async - Accepts a new WebSocket connection with the provided stream.
- accept_
async_ with_ config - The same as
accept_async()but the one can specify a websocket configuration. Please refer toaccept_async()for more details. - accept_
hdr_ async - Accepts a new WebSocket connection with the provided stream.
- accept_
hdr_ with_ config_ async - The same as
accept_hdr_async()but the one can specify a websocket configuration. Please refer toaccept_hdr_async()for more details. - client_
async - Creates a WebSocket handshake from a request and a stream.
- client_
async_ with_ config - The same as
client_async()but the one can specify a websocket configuration. Please refer toclient_async()for more details.
Type Aliases§
- Response
- Client response type.