Skip to main content

GossipOverlayManager

Struct GossipOverlayManager 

Source
pub struct GossipOverlayManager {
    pub stats: GossipStats,
    /* private fields */
}
Expand description

Manages the application-level gossip overlay.

All operations are thread-safe; queues and state are protected by Mutex/RwLock.

§Typical usage pattern

  1. Register known peers via add_peer.
  2. On network receive, call receive; it deduplicates and enqueues.
  3. Periodically call drain_outbound to obtain (target, msg) pairs and forward them over the transport layer.
  4. Call drain_inbound to pull novel messages for local processing.

Fields§

§stats: GossipStats

Implementations§

Source§

impl GossipOverlayManager

Source

pub fn with_fanout(fanout: usize) -> Self

Create a manager with a custom fanout width.

Source

pub fn add_peer(&self, peer_id: String)

Register a peer as a fanout candidate.

Source

pub fn remove_peer(&self, peer_id: &str)

Deregister a peer from the fanout candidate list.

Source

pub fn peer_count(&self) -> usize

Number of registered fanout candidate peers.

Source

pub fn receive(&self, msg: GossipMessage) -> bool

Process an incoming message.

Returns true when the message is novel (first time this sequence number from this peer has been seen). When novel, the message is:

  • pushed to the inbound queue for application processing, and
  • pushed to the outbound queue for each fanout target.

Returns false and increments the duplicate counter when the message was already seen.

Source

pub fn drain_inbound(&self) -> Vec<GossipMessage>

Drain and return all messages currently in the inbound queue.

Source

pub fn drain_outbound(&self) -> Vec<(String, GossipMessage)>

Drain and return all (target_peer_id, message) pairs from the outbound queue.

Source

pub fn broadcast(&self, msg: GossipMessage)

Broadcast msg to all registered fanout peers (ignoring the message’s own peer_id as a sender — useful for locally-originated messages).

Source

pub fn stats_snapshot(&self) -> GossipStatsSnapshot

A point-in-time snapshot of all gossip counters.

Trait Implementations§

Source§

impl Debug for GossipOverlayManager

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for GossipOverlayManager

Source§

fn default() -> GossipOverlayManager

Returns the “default value” for a type. 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