Struct libp2p::core::nodes::collection::PeerMut

pub struct PeerMut<'a, TInEvent, TUserData, TConnInfo = PeerId, TPeerId = PeerId> where
    TConnInfo: 'a,
    TInEvent: 'a,
    TPeerId: 'a,
    TUserData: 'a,  { /* fields omitted */ }

Access to a peer in the collection.

Methods

impl<'a, TInEvent, TUserData, TConnInfo, TPeerId> PeerMut<'a, TInEvent, TUserData, TConnInfo, TPeerId>

pub fn info(&self) -> &TConnInfo

Returns the information of the connection with the peer.

impl<'a, TInEvent, TUserData, TConnInfo, TPeerId> PeerMut<'a, TInEvent, TUserData, TConnInfo, TPeerId> where
    TConnInfo: ConnectionInfo<PeerId = TPeerId>,
    TPeerId: Eq + Hash, 

pub fn id(&self) -> &TPeerId

Returns the identity of the peer.

pub fn user_data(&self) -> &TUserData

Returns the user data that was stored in the collections when we accepted the connection.

pub fn user_data_mut(&mut self) -> &mut TUserData

Returns the user data that was stored in the collections when we accepted the connection.

pub fn send_event(&mut self, event: TInEvent)

Sends an event to the given node.

pub fn close(self) -> TUserData

Closes the connections to this node. Returns the user data.

No further event will be generated for this node.

pub fn take_over(
    &mut self,
    id: InterruptedReachAttempt<TInEvent, TConnInfo, TUserData>
)

Gives ownership of a closed reach attempt. As soon as the connection to the peer (self) has some acknowledgment from the remote that its connection is alive, it will close the connection inside id.

The reach attempt will only be effectively cancelled once the peer (the object you're manipulating) has received some network activity. However no event will be ever be generated from this reach attempt, and this takes effect immediately.