Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nielsdos/tungstenite-rs
Personal fork of tungstenite
https://github.com/nielsdos/tungstenite-rs
Last synced: 27 days ago
JSON representation
Personal fork of tungstenite
- Host: GitHub
- URL: https://github.com/nielsdos/tungstenite-rs
- Owner: nielsdos
- Created: 2021-02-07T01:59:50.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-09T11:03:14.000Z (about 2 years ago)
- Last Synced: 2024-11-08T07:52:53.845Z (3 months ago)
- Language: Rust
- Homepage:
- Size: 626 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# Tungstenite
Lightweight stream-based WebSocket implementation for [Rust](https://www.rust-lang.org/).
```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`](https://github.com/snapview/tokio-tungstenite).
[](./LICENSE-MIT)
[](./LICENSE-APACHE)
[](https://crates.io/crates/tungstenite)
[](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.
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`. The following
features are available:
* `native-tls`
* `native-tls-vendored`
* `rustls-tls-native-roots`
* `rustls-tls-webpki-roots`
Choose the one that is appropriate for your needs.
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, but the PRs are welcome :wink:
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 well as possible.
Contributing
------------
Please report bugs and make feature requests [here](https://github.com/snapview/tungstenite-rs/issues).