octo
/
Zebra
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add useful docstrings

This commit is contained in:
Deirdre Connolly 2019-10-21 15:16:28 -04:00 committed by Deirdre Connolly
parent 3de34290e6
commit 32aea0cbf9
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
zebra-network/src/constants.rs
View File

@ -9,7 +9,16 @@ use crate::protocol::types::*;
pub const REQUEST_TIMEOUT: Duration = Duration::from_secs(10);
/// We expect to receive a message from a live peer at least once in this time duration.
// XXX this needs to be synchronized with the ping transmission times.
///
/// This is the sum of:
/// - the interval between connection heartbeats
/// - the timeout of a possible pending (already-sent) request
/// - the timeout for a possible queued request
/// - the timeout for the heartbeat request itself
///
/// This avoids explicit synchronization, but relies on the peer
/// connector actually setting up channels and these heartbeats in a
/// specific manner that matches up with this math.
pub const LIVE_PEER_DURATION: Duration = Duration::from_secs(60 + 10 + 10 + 10);
/// Regular interval for sending keepalive `Ping` messages to each
@ -39,6 +48,9 @@ mod tests {
use super::*;
/// This assures that the `Duration` value we are computing for
/// LIVE_PEER_DURATION actually matches the other const values it
/// relies on.
#[test]
fn ensure_live_peer_duration_value_matches_others() {
let constructed_live_peer_duration =