Expand description

Data structures and implementations for managing Splinter peers.

The public interface includes the structs PeerManager, PeerManagerConnector, PeerInterconnect and the enum PeerManagerNotification.

Modules

Data structures and implementations for sending and receiving messages from peers.

Structs

Used to keep track of peer references that are created only with an endpoint. When dropped, a request is sent to the PeerManager to remove a reference to the peer, thus removing the peer if no more references exist.

The PeerManager is in charge of keeping track of peers and their reference counts, as well as requesting connections from the ConnectionManager. If a peer has disconnected, the PeerManager will also try the peer’s other endpoints until one is successful.

The PeerManagerConnector will be used to make requests to the PeerManager.

PeerNotificationIter is used to receive notfications from the PeerManager. The notifications include:

Used to keep track of peer references. When dropped, the PeerRef will send a request to the PeerManager to remove a reference to the peer, thus removing the peer if no more references exist.

The Peer ID that contains both the peer’s authorization type at the local authorization for the local node

Enums

The authorization type specific peer ID

Messages that will be dispatched to all subscription handlers

Traits

The PeerLookup trait provides an interface for looking up details about individual peer connections.

Type Definitions