# Tungstenite Lightweight stream-based WebSocket implementation for [Rust](https://www.rust-lang.org/). ```rust use std::net::TcpListener; use std::thread::spawn; use tungstenite::server::accept; /// A WebSocket echo server 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. [![MIT licensed](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE-MIT) [![Apache-2.0 licensed](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](./LICENSE-APACHE) [![Crates.io](https://img.shields.io/crates/v/tungstenite.svg?maxAge=2592000)](https://crates.io/crates/tungstenite) [![Build Status](https://travis-ci.org/snapview/tungstenite-rs.svg?branch=master)](https://travis-ci.org/snapview/tungstenite-rs) [Documentation](https://docs.rs/tungstenite) Introduction ------------ This library provides an implementation of WebSockets, [RFC6455](https://tools.ietf.org/html/rfc6455). It allows for both synchronous (like TcpStream) and asynchronous usage and is easy to integrate into any third-party event loops including [MIO](https://github.com/tokio-rs/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. This library is a work in progress. Feel free to ask questions and send us pull requests. 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. There is no support for permessage-deflate at the moment. It's planned. Testing ------- Tungstenite is thoroughly tested and passes the [Autobahn Test Suite](https://crossbar.io/autobahn/) for WebSockets. It is also covered by internal unit tests as good as possible. Contributing ------------ Please report bugs and make feature requests [here](https://github.com/snapview/tungstenite-rs/issues).