https://github.com/snapview/tokio-tungstenite

Future-based Tungstenite for Tokio. Lightweight stream-based WebSocket implementation
https://github.com/snapview/tokio-tungstenite

asynchronous tokio tokio-tungstenite websocket websockets

Last synced: 12 days ago
JSON representation

Future-based Tungstenite for Tokio. Lightweight stream-based WebSocket implementation

• Host: GitHub
• URL: https://github.com/snapview/tokio-tungstenite
• Owner: snapview
• License: mit
• Created: 2017-03-17T17:15:58.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-05-14T07:59:16.000Z (6 months ago)
• Last Synced: 2024-05-18T16:46:08.863Z (6 months ago)
• Topics: asynchronous, tokio, tokio-tungstenite, websocket, websockets
• Language: Rust
• Homepage:
• Size: 274 KB
• Stars: 1,643
• Watchers: 28
• Forks: 223
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# tokio-tungstenite

Asynchronous WebSockets for Tokio stack.

[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)

[![Crates.io](https://img.shields.io/crates/v/tokio-tungstenite.svg?maxAge=2592000)](https://crates.io/crates/tokio-tungstenite)

[![Build Status](https://travis-ci.org/snapview/tokio-tungstenite.svg?branch=master)](https://travis-ci.org/snapview/tokio-tungstenite)

[Documentation](https://docs.rs/tokio-tungstenite)

## Usage

Add this in your `Cargo.toml`:

```toml

[dependencies]

tokio-tungstenite = "*"

```

Take a look at the `examples/` directory for client and server examples. You may also want to get familiar with

[Tokio](https://github.com/tokio-rs/tokio) if you don't have any experience with it.

## What is tokio-tungstenite?

This crate is based on [`tungstenite-rs`](https://github.com/snapview/tungstenite-rs) Rust WebSocket library and provides `Tokio` bindings and wrappers for it, so you

can use it with non-blocking/asynchronous `TcpStream`s from and couple it together with other crates from `Tokio` stack.

## Features

As with [`tungstenite-rs`](https://github.com/snapview/tungstenite-rs) TLS is supported on all platforms using [`native-tls`](https://github.com/sfackler/rust-native-tls) or [`rustls`](https://github.com/ctz/rustls) through feature flags: `native-tls`, `rustls-tls-native-roots` or `rustls-tls-webpki-roots` feature flags. Neither is enabled by default. See the `Cargo.toml` for more information. If you require support for secure WebSockets (`wss://`) enable one of them.

## Is it performant?

In essence, `tokio-tungstenite` is a wrapper for `tungstenite`, so the performance is capped by the performance of `tungstenite`. `tungstenite`

has a decent performance (it has been used in production for real-time communication software, video conferencing, etc), but it's definitely

not the fastest WebSocket library in the world at the moment of writing this note.

If performance is of a paramount importance for you (especially if you send **large messages**), then you might want to check other libraries

that have been designed to be performant or you could file a PR against `tungstenite` to improve the performance!

We are aware of changes that both `tungstenite` and `tokio-tungstenite` need in order to fill the gap of ~30% performance difference between `tungstenite`

and more performant libraries like `fastwebsockets`, but we have not worked on that yet as it was not required for the use case that original authors designed

the library for. In the course of past years we have merged several performance improvements submitted by the awesome community of Rust users who helped to improve

the library! For a quick summary of the pending performance problems/improvements, see [the comment](https://github.com/snapview/tungstenite-rs/issues/352#issuecomment-1537488614).