Struct PublicOverlay 

pub struct PublicOverlay { /* private fields */ }

Implementations

impl PublicOverlay

pub fn builder(overlay_id: OverlayId) -> PublicOverlayBuilder

pub fn overlay_id(&self) -> &OverlayId

pub fn entry_ttl_sec(&self) -> u32

pub fn peer_resolver(&self) -> &Option<PeerResolver>

pub fn unknown_peers_queue(&self) -> &UnknownPeersQueue

pub async fn query( &self, network: &Network, peer_id: &PeerId, request: Request, ) -> Result<Response>

pub async fn send( &self, network: &Network, peer_id: &PeerId, request: Request, ) -> Result<()>

pub fn ban_peer(&self, peer_id: PeerId) -> bool

Bans the given peer from the overlay.

Returns true if the peer was not already banned.

pub fn unban_peer(&self, peer_id: &PeerId) -> bool

Unbans the given peer from the overlay.

Returns true if the peer was banned.

pub fn read_entries(&self) -> PublicOverlayEntriesReadGuard<'_>

pub fn entires_added(&self) -> &Notify

Notifies when new entries are added to the overlay.

pub fn entries_changed(&self) -> &Notify

Notifies when entries are updated in the overlay (added or updated).

pub fn entries_removed(&self) -> &Notify

pub fn own_signed_entry(&self) -> Option<Arc<PublicEntry>>

Own signed public entry.

Trait Implementations

impl Clone for PublicOverlay

fn clone(&self) -> PublicOverlay

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PublicOverlay

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.