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.
 
 
Daniel Abramov 1bbb4ce292
Merge pull request #247 from snapview/clippy-fixes
3 years ago
.github Enable dependabot 4 years ago
autobahn tests: rely on Autobahn Suite usage from docker 4 years ago
benches Implement benchmarks for buffers 4 years ago
examples Add a connector to configure TLS config 3 years ago
fuzz Edition 2018, formatting, clippy fixes 5 years ago
scripts tests: rely on Autobahn Suite usage from docker 4 years ago
src Fix newly introduced clippy warnings 3 years ago
tests Add a connector to configure TLS config 3 years ago
.gitignore Initial commit, mostly working client 8 years ago
.travis.yml tests: rely on Autobahn Suite usage from docker 4 years ago
CHANGELOG.md Remove the "unreleased" suffix from the changelog 3 years ago
Cargo.toml Update net2 to 0.2.37 3 years ago
LICENSE-APACHE Relicense under MIT + Apache-2.0. 8 years ago
LICENSE-MIT Relicense under MIT + Apache-2.0. 8 years ago
README.md Fixes #230 3 years ago
rustfmt.toml Fix clippy warnings and deprecated settings 3 years ago

README.md

Tungstenite

Lightweight stream-based WebSocket implementation for Rust.

use std::net::TcpListener;
use std::thread::spawn;
use tungstenite::accept;

/// A WebSocket echo server
fn main () {
    let server = TcpListener::bind("127.0.0.1:9001").unwrap();
    for stream in server.incoming() {
        spawn (move || {
            let mut websocket = accept(stream.unwrap()).unwrap();
            loop {
                let msg = websocket.read_message().unwrap();

                // We do not want to send back ping/pong messages.
                if msg.is_binary() || msg.is_text() {
                    websocket.write_message(msg).unwrap();
                }
            }
        });
    }
}

Take a look at the examples section to see how to write a simple client/server.

NOTE: tungstenite-rs is more like a barebone to build reliable modern networking applications using WebSockets. If you're looking for a modern production-ready "batteries included" WebSocket library that allows you to efficiently use non-blocking sockets and do "full-duplex" communication, take a look at tokio-tungstenite.

MIT licensed Apache-2.0 licensed Crates.io Build Status

Documentation

Introduction

This library provides an implementation of WebSockets, RFC6455. It allows for both synchronous (like TcpStream) and asynchronous usage and is easy to integrate into any third-party event loops including MIO. The API design abstracts away all the internals of the WebSocket protocol but still makes them accessible for those who wants full control over the network.

Why Tungstenite?

It's formerly WS2, the 2nd implementation of WS. WS2 is the chemical formula of tungsten disulfide, the tungstenite mineral.

Features

Tungstenite provides a complete implementation of the WebSocket specification. TLS is supported on all platforms using native-tls or rustls available through the native-tls and rustls-tls feature flags. By default no TLS feature is activated, so make sure you use native-tls or rustls-tls feature if you need support of the TLS.

There is no support for permessage-deflate at the moment. It's planned.

Testing

Tungstenite is thoroughly tested and passes the Autobahn Test Suite for WebSockets. It is also covered by internal unit tests as well as possible.

Contributing

Please report bugs and make feature requests here.