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

aquatic_ws: add some serde attributes on protocol data types

Browse source
This commit is contained in:
Joakim Frostegård 2020-05-07 19:42:15 +02:00
parent 4d0c3d309a
commit b2b4f5bb89
2 changed files with 8 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

4
TODO.md
View file

@ -1,10 +1,8 @@
# TODO # TODO
## aquatic_ws ## aquatic_ws
* serde
* AnnonunceWrapper or ActionWrapper or the like with an action field
and serde flatten on inner message
* handler * handler
* test
## aquatic ## aquatic
* mio: set oneshot for epoll and kqueue? otherwise, stop reregistering? * mio: set oneshot for epoll and kqueue? otherwise, stop reregistering?

8
aquatic_ws/src/lib/protocol.rs
View file

@ -22,6 +22,7 @@ pub struct ResponsePeer {
#[derive(Clone, Deserialize)] #[derive(Clone, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum AnnounceEvent { pub enum AnnounceEvent {
Started, Started,
Stopped, Stopped,
@ -73,7 +74,9 @@ pub struct AnnounceRequestOffer {
pub struct AnnounceRequest { pub struct AnnounceRequest {
pub info_hash: InfoHash, // FIXME: I think these are actually really just strings with 20 len, same with peer id pub info_hash: InfoHash, // FIXME: I think these are actually really just strings with 20 len, same with peer id
pub peer_id: PeerId, pub peer_id: PeerId,
#[serde(rename = "left")]
pub bytes_left: bool, // Just called "left" in protocol pub bytes_left: bool, // Just called "left" in protocol
#[serde(default)]
pub event: AnnounceEvent, // Can be empty? Then, default is "update" pub event: AnnounceEvent, // Can be empty? Then, default is "update"
// Length of this is number of peers wanted? // Length of this is number of peers wanted?
@ -82,6 +85,7 @@ pub struct AnnounceRequest {
/// If false, send response before sending offers (or possibly "skip sending update back"?) /// If false, send response before sending offers (or possibly "skip sending update back"?)
/// If true, send MiddlemanAnswerToPeer to peer with "to_peer_id" as peer_id. /// If true, send MiddlemanAnswerToPeer to peer with "to_peer_id" as peer_id.
#[serde(default)]
pub answer: bool, pub answer: bool,
pub to_peer_id: Option<PeerId>, // Only parsed to hex if answer == true, probably undefined otherwise pub to_peer_id: Option<PeerId>, // Only parsed to hex if answer == true, probably undefined otherwise
} }
@ -95,7 +99,8 @@ pub struct AnnounceResponse {
// I suspect receivers don't care about this and rely on offers instead?? // I suspect receivers don't care about this and rely on offers instead??
// Also, what does it contain, exacly (not certain that it is ResponsePeer?) // Also, what does it contain, exacly (not certain that it is ResponsePeer?)
pub peers: Vec<ResponsePeer>, pub peers: Vec<ResponsePeer>,
pub interval: usize, // Default 2 min probably #[serde(rename = "interval")]
pub announce_interval: usize, // Default 2 min probably
// Sent to "to_peer_id" peer (?? or did I put this into MiddlemanAnswerToPeer instead?) // Sent to "to_peer_id" peer (?? or did I put this into MiddlemanAnswerToPeer instead?)
// pub offer_id: (), // pub offer_id: (),
@ -128,6 +133,7 @@ pub struct ScrapeResponse {
#[derive(Clone, Serialize, Deserialize)] #[derive(Clone, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum Action { pub enum Action {
Announce, Announce,
Scrape Scrape