Skip to main content

PeerPool

Struct PeerPool 

Source
pub struct PeerPool {
    pub id: PeerID,
    conn_queue: Arc<ConnQueue>,
    peers: RwLock<HashMap<PeerID, Arc<Peer>>>,
    next_conn_id: AtomicU64,
    pub(crate) protocols: RwLock<HashMap<ProtocolID, Box<ProtocolConstructor>>>,
    pub(crate) protocol_meta: RwLock<HashMap<ProtocolID, ProtocolMeta>>,
    peer_emitter: Arc<EventEmitter<PeerEventTopic>>,
    task_group: TaskGroup,
    pub(crate) executor: Executor,
    pub(crate) config: Arc<Config>,
    monitor: Arc<Monitor>,
}

Fields§

§id: PeerID

Peer’s ID

§conn_queue: Arc<ConnQueue>

Connection queue

§peers: RwLock<HashMap<PeerID, Arc<Peer>>>

Holds the running peers.

§next_conn_id: AtomicU64

Next connection id, see Peer::conn_id.

§protocols: RwLock<HashMap<ProtocolID, Box<ProtocolConstructor>>>

Hashmap contains protocol constructors.

§protocol_meta: RwLock<HashMap<ProtocolID, ProtocolMeta>>

Per-protocol metadata (version + kind, extensible). Keyed by protocol id. Source of truth for the handshake’s mandatory check and version negotiation.

§peer_emitter: Arc<EventEmitter<PeerEventTopic>>

Peer-lifecycle event emitter. Each registered listener gets its own copy of every event.

§task_group: TaskGroup

Managing spawned tasks.

§executor: Executor

A global Executor

§config: Arc<Config>

The Configuration for the P2P network.

§monitor: Arc<Monitor>

Responsible for network and system monitoring.

Implementations§

Source§

impl PeerPool

Source

pub fn new( id: &PeerID, conn_queue: Arc<ConnQueue>, config: Arc<Config>, monitor: Arc<Monitor>, executor: Executor, ) -> Arc<Self> ⓘ

Creates a new PeerPool

Source

pub fn register_peer_events(&self) -> EventListener<PeerEventTopic, PeerEvent>

Register a listener for the peer-lifecycle events.

Source

pub async fn start(self: &Arc<Self>) -> Result<()>

Starts the PeerPool

Source

pub async fn shutdown(&self)

Shuts down

Source

pub async fn attach_protocol<P: Protocol>( &self, c: Box<ProtocolConstructor>, ) -> Result<()>

Register a protocol’s user-supplied constructor and metadata. Bloom advertising is handled by Node::attach_protocol.

Source

pub async fn broadcast(&self, proto_id: &ProtocolID, msg: Vec<u8>)

Broadcast a message to all connected peers.

Source

pub async fn broadcast_to( &self, proto_id: &ProtocolID, msg: Vec<u8>, targets: &HashSet<PeerID>, )

Broadcast a message to a specific set of peers.

Source

pub async fn send_to( &self, peer_id: &PeerID, proto_id: &ProtocolID, msg: Vec<u8>, ) -> Result<()>

Send a message to a specific peer on the given protocol. Returns PeerNotFound if the peer is not currently in the pool.

Source

pub async fn peer_protocol_set( &self, pid: &PeerID, ) -> Option<HashSet<ProtocolID>>

Returns the negotiated protocol set for a peer.

Source

pub async fn contains_peer(&self, pid: &PeerID) -> bool

Checks if the peer list contains a peer with the given peer id

Source

pub async fn peers_len(&self) -> usize

Returns the number of currently connected peers.

Source

pub async fn inbound_peers(&self) -> HashMap<PeerID, Endpoint>

Returns a map of inbound peers with their endpoints.

Source

pub async fn outbound_peers(&self) -> HashMap<PeerID, Endpoint>

Returns a map of outbound peers with their endpoints.

Source

async fn run(self: Arc<Self>)

Source

async fn admit(self: Arc<Self>, queued: QueuedConn)

Handshake a queued connection and add it to the pool.

Source

async fn new_peer( self: &Arc<Self>, queued: QueuedConn, pid: PeerID, negotiated: Vec<ProtocolID>, ) -> Result<()>

Build a Peer from a post-handshake QueuedConn and run it.

Source

async fn insert_peer( self: &Arc<Self>, queued: QueuedConn, pid: &PeerID, negotiated: HashSet<ProtocolID>, ) -> Result<(Arc<Peer>, Option<Arc<Peer>>)>

Builds the peer and adds it. If a peer with this id is already in the pool, the new connection either replaces it (returned as the second value, for the caller to shut down) or is rejected; see new_conn_wins. Connections are admitted in parallel, so the check and the insert run under one write lock. Peer::new does not wait for the remote, so the lock is held only briefly.

Source

async fn remove_peer(&self, peer: &Arc<Peer>) -> Result<()>

Shuts down the peer and removes it from the peer list. Does nothing if the pool holds another peer under this id (the connection was replaced) or none.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more