[−][src]Crate tokio_tungstenite
Async WebSocket usage.
This library is an implementation of WebSocket handshakes and streams. It is based on the crate which implements all required WebSocket protocol logic. So this crate basically just brings tokio support / tokio integration to it.
Each WebSocket stream implements the required Stream
and Sink
traits,
so the socket is just a stream of messages coming in and going out.
Re-exports
pub extern crate tungstenite; |
pub use stream::PeerAddr; |
Modules
stream | Convenience wrapper for streams to switch between plain TCP and TLS at runtime. |
Structs
AcceptAsync | Future returned from accept_async() which will resolve once the connection handshake has finished. |
ConnectAsync | Future returned from client_async() which will resolve once the connection handshake has finished. |
WebSocketStream | A wrapper around an underlying raw stream which implements the WebSocket protocol. |
Functions
accept_async | Accepts a new WebSocket connection with the provided stream. |
accept_async_with_config | The same as |
accept_hdr_async | Accepts a new WebSocket connection with the provided stream. |
accept_hdr_async_with_config | The same as |
client_async | Creates a WebSocket handshake from a request and a stream.
For convenience, the user may call this with a url string, a URL,
or a |
client_async_tls | Creates a WebSocket handshake from a request and a stream, upgrading the stream to TLS if required. |
client_async_with_config | The same as |
connect_async | Connect to a given URL. |
Type Definitions
MaybeTlsStream | A stream that might be protected with TLS. |