netapp/src/lib.rs

33 lines
888 B
Rust
Raw Normal View History

2020-12-02 19:12:24 +00:00
//! Netapp is a Rust library that takes care of a few common tasks in distributed software:
//!
2020-12-02 19:12:24 +00:00
//! - establishing secure connections
//! - managing connection lifetime, reconnecting on failure
//! - checking peer's state
//! - peer discovery
//! - query/response message passing model for communications
//! - multiplexing transfers over a connection
2020-12-14 10:41:25 +00:00
//! - overlay networks: full mesh, and soon other methods
2020-12-02 19:12:24 +00:00
//!
//! Of particular interest, read the documentation for the `netapp::NetApp` type,
//! the `message::Message` trait, and `proto::RequestPriority` to learn more
//! about message priorization.
//! Also check out the examples to learn how to use this crate.
2020-12-02 12:30:47 +00:00
pub mod error;
2020-12-02 19:12:24 +00:00
pub mod util;
2021-10-12 15:59:46 +00:00
pub mod endpoint;
pub mod proto;
2020-12-02 19:12:24 +00:00
mod client;
mod server;
2020-12-02 19:12:24 +00:00
2020-12-02 12:30:47 +00:00
pub mod netapp;
pub mod peering;
2020-12-02 19:12:24 +00:00
2021-10-13 16:05:49 +00:00
pub use crate::netapp::*;
2021-10-14 10:08:39 +00:00
pub use util::{NetworkKey, NodeID, NodeKey};
2021-10-13 16:05:49 +00:00
#[cfg(test)]
mod test;