Struct PeerStore

pub struct PeerStore { /* private fields */ }

Peer store

| – choose to identify –| — choose to feeler — | – delete – | | 1 | 2 | 3 | 4 | 5 | 6 | 7 | More than seven days |

Implementations

impl PeerStore

pub fn load_from_dir_or_default<P: AsRef<Path>>(path: P) -> Self

Init peer store from disk

pub fn dump_to_dir<P: AsRef<Path>>(&self, path: P) -> Result<(), Error>

Dump all info to disk

impl PeerStore

pub fn new(addr_manager: AddrManager, ban_list: BanList) -> Self

New with address list and ban list

pub fn add_connected_peer(&mut self, addr: Multiaddr, session_type: SessionType)

this method will assume peer is connected, which implies address is “verified”.

pub fn add_addr(&mut self, addr: Multiaddr, flags: Flags) -> Result<()>

Add discovered peer address this method will assume peer and addr is untrust since we have not connected to it.

pub fn add_outbound_addr(&mut self, addr: Multiaddr, flags: Flags)

Add outbound peer address

pub fn update_outbound_addr_last_connected_ms(&mut self, addr: Multiaddr)

Update outbound peer last connected ms

pub fn addr_manager(&self) -> &AddrManager

Get address manager

pub fn mut_addr_manager(&mut self) -> &mut AddrManager

Get mut address manager

pub fn report(&mut self, addr: &Multiaddr, behaviour: Behaviour) -> ReportResult

Report peer behaviours

pub fn remove_disconnected_peer(&mut self, addr: &Multiaddr) -> Option<PeerInfo>

Remove peer id

pub fn peer_status(&self, peer_id: &PeerId) -> Status

Get peer status

pub fn fetch_addrs_to_attempt<F>( &mut self, count: usize, required_flags: Flags, filter: F, ) -> Vec<AddrInfo>

where F: Fn(&AddrInfo) -> bool,

Get peers for outbound connection, this method randomly return recently connected peer addrs

pub fn fetch_addrs_to_feeler<F>( &mut self, count: usize, filter: F, ) -> Vec<AddrInfo>

where F: Fn(&AddrInfo) -> bool,

Get peers for feeler connection, this method randomly return peer addrs that we never connected to.

pub fn fetch_random_addrs( &mut self, count: usize, required_flags: Flags, ) -> Vec<AddrInfo>

Return valid addrs that success connected, used for discovery.

pub fn is_addr_banned(&self, addr: &Multiaddr) -> bool

Whether the address is banned

pub fn ban_list(&self) -> &BanList

Get ban list

pub fn mut_ban_list(&mut self) -> &mut BanList

Get mut ban list

pub fn clear_ban_list(&mut self)

Clear ban list

Trait Implementations

impl Default for PeerStore

fn default() -> PeerStore

Returns the “default value” for a type.