Struct ProtocolHandshaker 

pub struct ProtocolHandshaker {
    pub local_offer: HandshakeOffer,
    pub stats: Arc<HandshakeStats>,
}

Drives the protocol negotiation for a single local peer.

A ProtocolHandshaker is constructed once per local node and then called for every incoming or outgoing connection to negotiate shared parameters with the remote peer.

Thread safety

The statistics field uses Arc<HandshakeStats> so the same stats object can be shared across tasks/threads without requiring &mut self.

Fields

local_offer: HandshakeOffer

The offer that the local node will present to every remote peer.

stats: Arc<HandshakeStats>

Accumulated handshake statistics.

Implementations

impl ProtocolHandshaker

pub fn new(local_offer: HandshakeOffer) -> Self

Create a new handshaker with the given local offer.

pub fn local_features(&self) -> Vec<FeatureFlag>

Return the feature flags advertised by the local peer.

pub fn negotiate( &self, remote: &HandshakeOffer, ) -> Result<HandshakeResult, HandshakeError>

Negotiate protocol parameters with a remote peer.

On success, returns a HandshakeResult describing the agreed parameters. On failure, returns a HandshakeError.

Steps

1. Validate the remote offer.
2. Check that major versions match.
3. Intersect feature-flag bitmasks.
4. Agree on the smaller of the two maximum frame sizes.
5. Choose the lower of the two protocol versions as the agreed version so that the less-advanced peer is never asked to speak a version it cannot fully implement.

Trait Implementations

impl Debug for ProtocolHandshaker

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

Formats the value using the given formatter.