|
1 | 1 | # twamp-rs |
2 | 2 |
|
3 | | -<div align="center"> |
4 | | - |
5 | 3 | [![Crate Badge]][Crate] [![Docs Badge]][Docs] [![License Badge]][License] |
6 | | -</div> |
7 | 4 |
|
8 | | -This crate provides an implementation of TWAMP [RFC 5357](https://datatracker.ietf.org/doc/html/rfc5357) along with building blocks for making your own. |
| 5 | +This crate provides an implementation of TWAMP |
| 6 | +[RFC 5357](https://datatracker.ietf.org/doc/html/rfc5357) |
| 7 | +along with building blocks for making your own. |
9 | 8 |
|
10 | 9 | ## Features |
| 10 | + |
| 11 | +This also loosely serves as roadmap (checkpoint order). |
| 12 | + |
11 | 13 | - [x] TWAMP-Control |
12 | 14 | - [x] TWAMP-Test |
13 | 15 | - [x] Control-Client |
14 | 16 | - [x] Server |
15 | 17 | - [x] Session-Sender |
16 | 18 | - [x] Session-Reflector |
17 | | -- [ ] Security Modes |
18 | | - - [x] Unauthenticated |
19 | | - - [ ] Authenticated |
20 | | - - [ ] Encrypted |
21 | | -- [ ] DSCP (QoS) |
22 | 19 | - [x] TWAMP-full |
23 | | - - [x] Controller (control-client + session-sender) |
24 | | - - [x] Responder (server + session-reflector) |
| 20 | + - [x] Controller (control-client + session-sender) |
| 21 | + - [x] Responder (server + session-reflector) |
25 | 22 | - [ ] TWAMP-Light |
26 | | - - [ ] Controller (server + control-client + session-sender) |
27 | | - - [ ] Responder (session-reflector) |
| 23 | + - [ ] Controller (server + control-client + session-sender) |
| 24 | + - [ ] Responder (session-reflector) |
28 | 25 | - [ ] STAMP |
| 26 | +- [ ] Security Modes |
| 27 | + - [x] Unauthenticated |
| 28 | + - [ ] Authenticated |
| 29 | + - [ ] Encrypted |
| 30 | +- [ ] DSCP (QoS) |
29 | 31 |
|
30 | 32 | ## Setup and run |
| 33 | + |
31 | 34 | ```bash |
32 | 35 | # Run server first. |
33 | 36 | > cargo run --example responder -- --port 4000 # defaults to 862 which needs permissions |
@@ -95,13 +98,9 @@ sudo sysctl -w net.core.rmem_default=16777216 |
95 | 98 | 2025-01-31T07:29:30.866345Z INFO controller::controller: Jitter: 0.00ms |
96 | 99 | ``` |
97 | 100 |
|
98 | | -[Repo]: https://github.com/thatdevsherry/twamp-rs |
99 | 101 | [Docs]: https://docs.rs/twamp-rs |
100 | | -[Changelog]: https://github.com/thatdevsherry/twamp-rs/blob/main/CHANGELOG.md |
101 | | -[Conventional Commits]: https://www.conventionalcommits.org |
102 | 102 | [Crate]: https://crates.io/crates/twamp-rs |
103 | 103 | [Crate Badge]: https://img.shields.io/crates/v/twamp-rs?logo=rust&style=flat-square&color=fdbb39 |
104 | | -[Repo Badge]: https://img.shields.io/badge/repo-thatdevsherry/twamp-rs?style=flat-square&logo=github&color=blue |
105 | 104 | [Docs Badge]: https://img.shields.io/badge/docs-twamp-rs?style=flat-square&logo=rust&color=red |
106 | 105 | [License]: ./LICENSE.txt |
107 | 106 | [License Badge]: https://img.shields.io/crates/l/twamp-rs?style=flat-square&color=1370D3 |
0 commit comments