Skip to main content

PeerCapabilityNegotiator

Struct PeerCapabilityNegotiator 

Source
pub struct PeerCapabilityNegotiator {
    pub config: NegotiatorConfig,
    pub negotiation_history: VecDeque<NegotiationRecord>,
    pub max_history: usize,
    pub total_negotiations: u64,
    pub total_accepted: u64,
    pub total_rejected: u64,
}
Expand description

Production-grade peer capability negotiator.

PeerCapabilityNegotiator handles the full lifecycle of capability negotiation:

  1. Building NegotiationOffers from local config for outbound connections.
  2. Evaluating incoming offers and producing NegotiationResults.
  3. Recording negotiation outcomes in a bounded history ring.
  4. Exposing aggregate statistics for monitoring dashboards.

§Thread Safety

PeerCapabilityNegotiator is Send + Sync (all fields are Send + Sync). For concurrent access, wrap in Arc<Mutex<_>> or Arc<RwLock<_>>.

Fields§

§config: NegotiatorConfig

Local negotiation configuration (policy, capabilities, limits).

§negotiation_history: VecDeque<NegotiationRecord>

Bounded ring of historical negotiation records (newest last).

§max_history: usize

Maximum number of historical records retained.

§total_negotiations: u64

Total number of negotiate() calls.

§total_accepted: u64

Negotiations that returned Accepted.

§total_rejected: u64

Negotiations that returned Rejected.

Implementations§

Source§

impl PeerCapabilityNegotiator

Source

pub fn new(config: NegotiatorConfig, max_history: usize) -> Self

Create a new negotiator with the given config and maximum history size.

§Panics

Does not panic; a max_history of 0 is valid (no history retained).

Source

pub fn build_offer(&self, peer_id: String, now: u64) -> NegotiationOffer

Build a NegotiationOffer from this node’s local capabilities.

peer_id is the identifier we place in the offer (usually our own peer ID), and now is the current Unix-millisecond timestamp.

Source

pub fn evaluate_offer(&self, offer: &NegotiationOffer) -> NegotiationResult

Evaluate an incoming peer offer and return the negotiation outcome.

The evaluation proceeds in three phases:

  1. Protocol version gate — if offer.protocol_version < min_protocol_version, immediately return Rejected { reason: "protocol version too low", ... }.
  2. Required-capability scan — identify which locally required capabilities are absent from (or version-incompatible with) the offer.
  3. Policy decision — apply CapabilityPolicy to decide Accepted/Rejected.
Source

pub fn negotiate( &mut self, peer_id: String, offer: NegotiationOffer, start_ms: u64, end_ms: u64, ) -> &NegotiationResult

Evaluate an offer, record it in history, update counters, and return the result.

  • peer_id — identifier of the remote peer.
  • offer — the remote peer’s capability offer.
  • start_ms — Unix-millisecond timestamp when the negotiation began.
  • end_ms — Unix-millisecond timestamp when evaluation completed.

Returns a reference to the stored NegotiationResult in the history ring.

§History Eviction

When the history ring is full (len() == max_history), the oldest record is evicted before the new one is appended. If max_history is 0, the record is computed and counters are updated but nothing is stored.

Source

pub fn is_capability_supported( &self, name: &str, version: &CapabilityVersion, ) -> bool

Returns true if the local config contains a capability with name whose version is compatible with version.

Source

pub fn common_capabilities(&self, offer: &NegotiationOffer) -> Vec<String>

Returns the names of capabilities present in both the local config and the offer, with a compatible version.

Source

pub fn history_for_peer(&self, peer_id: &str) -> Vec<&NegotiationRecord>

Returns all historical records for the specified peer.

Source

pub fn negotiator_stats(&self) -> NegotiatorStats

Snapshot of aggregate negotiation statistics.

Trait Implementations§

Source§

impl Debug for PeerCapabilityNegotiator

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

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

Source§

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

Source§

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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