You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Alexey Galakhov 8b13cb7ad3 test: add autobahn tests 5 years ago
autobahn test: add autobahn tests 5 years ago
examples test: add autobahn tests 5 years ago
scripts test: add autobahn tests 5 years ago
src Update to the latest `tungstenite-rs` version 5 years ago
tests Update tokio-tls to 0.2 and replace fully tokio-core with tokio 6 years ago
.gitignore Repository created. 8 years ago
.travis.yml test: add autobahn tests 5 years ago
Cargo.toml test: add autobahn tests 5 years ago
LICENSE Add license and update manifest 7 years ago
README.md Fix Usage typo 7 years ago

README.md

tokio-tungstenite

Asynchronous WebSockets for Tokio stack.

MIT licensed Crates.io Build Status

Documentation

Usage

First, you need to add this in your Cargo.toml:

[dependencies]
tokio-tungstenite = "*"

Next, add this to your crate:

extern crate tokio_tungstenite;

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

What is tokio-tungstenite?

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