ws-tool

An easy to use websocket client/server toolkit, supporting blocking/async IO.

feature matrix

It's tested by autobaha test suit. see test report of 4 example

usage

Every example can be run with

cargo run --example <example_name> --all-features

command.

See examples/server for building a websocket echo server with self signed certs.

• examples/echo demonstrates how to connect to a server.
• echo_server demonstrates how to setup a server.
• deflate_client and deflate_server demostrate how to enable permessage-deflate extension
• binance demostrates how to connect to wss server via http/socks proxy
• autobaha_xxx_client are autobaha test suit client
• bench_xxx are benchmark server examples, showing how to control read/write buffer or other low level config

run autobaha testsuit

start test server

./script/start_autobahn_server.sh

run test on other terminal

cargo ac
cargo aac
cargo adc
cargo aadc

report files should be under test_reports dir.

performance

Performance is a complex issue, and a single performance indicator is not enough to describe the performance of a certain library. Here we only compare QPS as a brief description of ws-tool performance

My test machine is i9-12900k and 32GB, 3200MHz ddr4, and load test client is load_test

Roughly compare with EchoSever example, tungstenite

The following are the benchmark(1 connection only) results

300 bytes payload size, 50000000 messages

cargo lt -- -p 300 --count 50000 -t 1 <url>

1M bytes payload size, 100000 messages

cargo lt -- -p 1048576 --count 100 -t 1 <url>

you can try more combinations with load_test tool

http header style

for multiple extension/protocol, ws-tool prefer to use multiple header with the same name, instead of "," separated value. but ws-tool still try to parse extension/protocol from "," separated header value.

REF

• WebSocket RFC
• permessage-deflate RFC
• tungstenite-rs
• ws-rs