YGGverse/aquatic
1
0
Fork 0
mirror of https://github.com/YGGverse/aquatic.git synced 2026-04-02 02:35:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

aquatic_ws_protocol: add documentation (as comments)

Browse source
This commit is contained in:
Joakim Frostegård 2021-10-16 01:53:28 +02:00
parent c02d7f2113
commit 6624df1e44
3 changed files with 19 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

12
aquatic_ws_protocol/src/lib.rs
View file

@ -1,3 +1,15 @@
//! WebTorrent protocol implementation
//!
//! Typical announce workflow:
//! - Peer A sends announce request with info hash and offers
//! - Tracker sends on offers to other peers announcing with that info hash and
//! sends back announce response to peer A
//! - Tracker receives answers to those offers from other peers and send them
//! on to peer A
//!
//! Typical scrape workflow
//! - Peer sends scrape request and receives scrape response
pub mod common;
pub mod request;
pub mod response;