rings-measure 0.20.0

Pure local peer credit and reliability algorithms for Rings
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

#![deny(missing_docs)]

//! Pure local peer measurement algorithms.
//!
//! This crate models two independent local relations:
//!
//! - [`CreditRecord`] records useful bytes exchanged with an authenticated peer
//!   and computes an aMule-compatible [`CreditScore`].
//! - [`ReliabilityWindow`] records recent logical transport outcomes and derives
//!   a [`ReliabilityClass`] used only for advisory ordering.
//!
//! Time, storage, networking, tasks, locks, and process lifecycle are effects.
//! Callers pass timestamps and explicitly attributable events into the pure
//! [`MeasurementLedger`] transition and persist [`MeasurementSnapshot`] values
//! outside this crate.

mod credit;
mod error;
mod event;
mod ledger;
mod reliability;
mod snapshot;
mod time;

pub use credit::CreditPolicy;
pub use credit::CreditRecord;
pub use credit::CreditScore;
pub use error::MeasureError;
pub use error::PolicyError;
pub use event::ApplyOutcome;
pub use event::Authentication;
pub use event::MeasurementBatch;
pub use event::MeasurementEvent;
pub use event::Metric;
pub use ledger::ApplyReport;
pub use ledger::LedgerReconciliation;
pub use ledger::MeasurementLedger;
pub use ledger::MeasurementPage;
pub use ledger::MeasurementProjection;
pub use ledger::PeerMeasurement;
pub use ledger::PeerMeasurementFailure;
pub use ledger::PeerRecord;
pub use ledger::PruneReport;
pub use ledger::DEFAULT_MAX_RETAINED_PEERS;
pub use reliability::order_peers_by_reliability;
pub use reliability::ReliabilityClass;
pub use reliability::ReliabilityEvidence;
pub use reliability::ReliabilityPolicy;
pub use reliability::ReliabilityThresholds;
pub use reliability::ReliabilityWindow;
pub use snapshot::MeasurementSnapshot;
pub use snapshot::SnapshotRecord;
pub use snapshot::MEASUREMENT_SNAPSHOT_VERSION;
pub use time::UnixTime;