15 releases
0.6.4 | Sep 7, 2024 |
---|---|
0.6.2 | Jan 30, 2024 |
0.6.1 | Nov 16, 2023 |
0.5.1 | Mar 17, 2023 |
0.1.0 | Mar 23, 2022 |
#41 in WebSocket
818 downloads per month
Used in 10 crates
(6 directly)
125KB
2.5K
SLoC
ezsockets
Creating a WebSocket server or a client in Rust can be troublesome. This crate facilitates this process by providing:
- Traits to allow declarative and event-based programming.
- Easy concurrency with Tokio and async/await. Server sessions are Clone'able and can be shared between tasks.
- Heartbeat mechanism to keep the connection alive.
- Automatic reconnection of WebSocket Clients.
- Support for arbitrary client back-ends, with built-in native and WASM client connectors.
- Support for multiple server back-ends such as Axum or Tungstenite.
- TLS support for servers with
rustls
andnative-tls
.
Documentation
View the full documentation at docs.rs/ezsockets
Examples
simple-client
- a simplest WebSocket client which uses stdin as input.echo-server
- server that echoes back every message it receives.echo-server
- same asecho-server
, but withnative-tls
.counter-server
- server that increments global value every second and shares it with clientchat-client
- chat client forchat-server
andchat-server-axum
exampleswasm-client
- chat client forchat-server
andchat-server-axum
examples that runs in the browser (only listens to the chat)chat-server
- chat server with support of roomschat-server-axum
- same as above, but usingaxum
as a back-end
Client
By default clients use tokio-tungstenite
under the hood. Disable default features and enable wasm_client
to run clients on WASM targets.
See examples/simple-client for a simple usage and docs.rs/ezsockets/server for documentation.
Server
WebSocket server can use one of the supported back-ends:
tokio-tungstenite
- the simplest way to get started.axum
- ergonomic and modular web framework built with Tokio, Tower, and Hyperactix-web
- Work in progress at #22
See examples/echo-server for a simple usage and docs.rs/ezsockets/server for documentation.
License
Licensed under MIT.
Contact
Reach me out on Discord gbaranski#5119
, or mail me at me@gbaranski.com.
Dependencies
~5–19MB
~285K SLoC