Nils Andreas Svee
56a2a653d0
Each published crate (irtt-rs, irtt-client, irtt-server, irtt-stats, irtt-proto) now points crates.io at its own README instead of inheriting the root project README via the workspace-wide readme default, which is removed. Each crate README is a short landing page: what the crate is, who should use it, which sibling crate to use instead if this isn't the right abstraction level, and links to docs.rs and the main repository. Add real Cargo example targets teaching irtt-client's blocking/Tokio/ managed API tiers, a basic and a multi-listener irtt-server example, and an irtt-stats example contrasting finite vs continuous retention. irtt-proto intentionally has none. Update each crate's top-level rustdoc to explain its API-tier choices and point at the examples, and enable docs.rs rustdoc example scraping for irtt-client and irtt-server (via doc-scrape-examples on each example target, needed because the crate has dev-dependencies). The client examples are caller-paced against next_send_deadline() rather than sending on every loop iteration, bound their receive wait by the next send/timeout deadline instead of awaiting indefinitely, poll timeouts on a short fixed cadence, and surface send/receive/close errors instead of discarding them via unwrap_or_default()/if-let-Ok -- so they demonstrate correct pacing and terminate/report cleanly rather than racing the server, hanging on a lost reply, or silently dropping a failed final close.
42 lines
1.6 KiB
Markdown
42 lines
1.6 KiB
Markdown
# irtt-server
|
|
|
|
Reusable, Tokio-native library for running an IRTT-compatible UDP server:
|
|
open negotiation, the bounded session table, echo processing, per-session
|
|
rate limiting, idle and max-duration expiry, and reply construction.
|
|
|
|
## Looking for the CLI?
|
|
|
|
If you just want to run a server from the command line, use the
|
|
[`irtt-rs`](https://crates.io/crates/irtt-rs) application package instead,
|
|
which installs the `irtt-server` binary. This crate is the library that
|
|
binary is built on.
|
|
|
|
## Structure
|
|
|
|
- `Server` — the one-listener primitive: one UDP socket, one deterministic
|
|
`ServerCore`, one sequential receive/reply loop.
|
|
- `ServerSet` — supervises one or more `Server`s as a single service: binds
|
|
them all or none, runs each in its own task, and fans one shutdown out to
|
|
all of them.
|
|
|
|
Unlike `irtt-client`, Tokio is not optional here — this crate is intentionally
|
|
Tokio-native, with no blocking or alternate-runtime variant.
|
|
|
|
A wildcard listener (`0.0.0.0` / `[::]`) recovers each request's local
|
|
destination and replies from it, so a client on a second local address is
|
|
answered from the address it actually contacted. That path is implemented
|
|
for Linux, macOS, and FreeBSD; a wildcard bind is refused at construction on
|
|
other targets rather than served incorrectly. Explicit-address listeners are
|
|
unaffected everywhere.
|
|
|
|
See `examples/` in the repository for runnable examples.
|
|
|
|
## Documentation
|
|
|
|
Full API documentation is on [docs.rs/irtt-server](https://docs.rs/irtt-server).
|
|
|
|
## Project
|
|
|
|
Part of [irtt-rs](https://github.com/Lochnair/irtt-rs), an independent Rust
|
|
implementation of an IRTT-compatible protocol stack.
|