lib3h 0.0.2-alpha1

The lib3h p2p communication rust library.
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

use crate::dht::dht_protocol::{DhtCommand, DhtEvent, PeerData};
use lib3h_protocol::{data_types::EntryData, AddressRef, DidWork, Lib3hResult};

#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
pub struct DhtConfig {
    pub this_peer_address: String,
    pub this_peer_transport: String,
    pub custom: Vec<u8>,
}

pub type DhtFactory<D> = fn(config: &DhtConfig) -> Lib3hResult<D>;

/// Allow storage and retrieval of peer & entry data.
/// Trait API is for query
/// DhtEvent is for mutating storage
pub trait Dht {
    /// Peer info
    fn get_peer(&self, peer_address: &str) -> Option<PeerData>;
    fn fetch_peer(&self, peer_address: &str) -> Option<PeerData>;
    fn get_peer_list(&self) -> Vec<PeerData>;
    fn this_peer(&self) -> &PeerData;
    /// Data
    fn get_entry(&self, entry_address: &AddressRef) -> Option<EntryData>;
    fn fetch_entry(&self, entry_address: &AddressRef) -> Option<EntryData>;
    /// Processing
    fn post(&mut self, cmd: DhtCommand) -> Lib3hResult<()>;
    fn process(&mut self) -> Lib3hResult<(DidWork, Vec<DhtEvent>)>;
}