fork of https://github.com/sdroege/async-tungstenite

Sebastian Dröge 9f3a1ee30b Add proxy waiters to allow the Stream to trigger AsyncWrite operations As a side effect also gets rid of unsafe code and raw pointers. We have the problem that external read operations (i.e. the Stream impl) can trigger both read (AsyncRead) and write (AsyncWrite) operations on the underyling stream. At the same time write operations (i.e. the Sink impl) can trigger write operations (AsyncWrite) too. Both the Stream and the Sink can be used on two different tasks, but it is required that AsyncRead and AsyncWrite are only ever used by a single task (or better: with a single waker) at a time. Doing otherwise would cause only the latest waker to be remembered, so in our case either the Stream or the Sink impl would potentially wait forever to be woken up because only the other one would've been woken up. To solve this we implement a waker proxy that has two slots (one for read, one for write) to store wakers. One waker proxy is always passed to the AsyncRead, the other to AsyncWrite so that they will only ever have to store a single waker, but internally we dispatch any wakeups to up to two actual wakers (one from the Sink impl and one from the Stream impl).		5 years ago
autobahn	test: add autobahn tests	6 years ago
examples	Format code using 'cargo fmt'	5 years ago
scripts	test: add autobahn tests	6 years ago
src	Add proxy waiters to allow the Stream to trigger AsyncWrite operations	5 years ago
tests	Format code using 'cargo fmt'	5 years ago
.gitignore	Repository created.	8 years ago
.travis.yml	Port/rename to async-std / async-tungstenite	5 years ago
Cargo.toml	Update to tungstenite 0.9.2 instead of tracking git master	5 years ago
LICENSE	Port/rename to async-std / async-tungstenite	5 years ago
README.md	Port/rename to async-std / async-tungstenite	5 years ago

README.md

async-tungstenite

Asynchronous WebSockets for async-std and std Futures.

Documentation

Usage

Add this in your Cargo.toml:

[dependencies]
async-tungstenite = "*"

Take a look at the examples/ directory for client and server examples. You may also want to get familiar with async-std if you don't have any experience with it.

What is async-tungstenite?

This crate is based on tungstenite-rs Rust WebSocket library and provides async-std bindings and wrappers for it, so you can use it with non-blocking/asynchronous TcpStreams from and couple it together with other crates from the async-std stack.

tokio-tungstenite

Originally this crate was created as a fork of tokio-tungstenite and ported to async-std.