Skip to main content

Crate parachuter

Crate parachuter 

Source
Expand description

§parachuter

Reliable, rate-limited file downlink over lossy unidirectional UDP links.

parachuter is a generic Rust crate inspired by, and first used on, the SuperBIT balloon telescope. It provides a versioned packet protocol, a chunker / reassembler that survives partial deliveries, an embedded SQLite ledger of sent files, and a length-prefixed JSON control plane that can be driven by the parachuter ctl subcommand to retune chunk size, link IPs, downlink speed and pause/resume the sender at runtime.

The crate is organised into five subsystems:

  • proto — on-the-wire packet layout, framing, parsing, CRCs.
  • chunker — split a file into a stream of proto::Packets.
  • reassembler — durably reassemble packets into a file using a packed bitmap manifest.
  • ledger — SQLite-backed table of files seen, sent, and acknowledged.
  • control — Unix-domain-socket control plane shared by every mode of the parachuter binary.
  • reconcile — ground-side check of the sender’s downlinked ledger against the final directory, to catch files lost whole.

See docs/DESIGN.md for the architecture overview.

Re-exports§

pub use error::Error;
pub use error::Result;

Modules§

chunker
Split a file into a sequence of crate::proto::Packets.
config
TOML-based runtime configuration with hot reload.
control
Length-prefixed JSON control plane.
error
Error type used across the crate.
ledger
Embedded SQLite ledger of files the sender knows about.
proto
Versioned, CRC-protected packet protocol for parachuter.
rate_limiter
Token-bucket rate limiter used by the sender to pace UDP transmits.
reassembler
Durable, bitmap-based packet reassembly.
reconcile
Ground-side reconciliation: catch files that were lost whole.
transport
UDP transport abstraction.