Skip to main content

GossipProtocolEngine

Struct GossipProtocolEngine 

Source
pub struct GossipProtocolEngine { /* private fields */ }
Expand description

Production-quality gossip dissemination protocol engine.

The engine is not async; it exposes a pure, synchronous API suitable for embedding inside higher-level async event loops. All state is owned by the struct and protected via &mut self.

Implementations§

Source§

impl GossipProtocolEngine

Source

pub fn new(config: GossipConfig) -> Self

Create a new engine with the given configuration.

The PRNG seed is derived from dedup_cache_size XOR a constant so that default-config engines are reproducible in tests.

Source

pub fn with_defaults() -> Self

Create an engine with default configuration.

Source

pub fn add_peer(&mut self, peer_id: String) -> Result<(), EngineError>

Register a new peer. Returns Ok(()) if the peer was added, or if it was already present (idempotent).

Source

pub fn remove_peer(&mut self, peer_id: &str) -> Result<(), EngineError>

Remove a registered peer. Returns Err(PeerNotFound) if absent.

Source

pub fn create_message( payload: Vec<u8>, topic: String, origin: String, timestamp: u64, max_hops: u8, ) -> Result<GossipMessage, EngineError>

Create a new GossipMessage with a computed FNV-1a ID.

timestamp should be a monotonically-increasing value (e.g. SystemTime::now() milliseconds); when running tests without a real clock, pass any non-zero value.

Source

pub fn receive_message( &mut self, msg: GossipMessage, ) -> Result<Vec<GossipEvent>, EngineError>

Process an incoming GossipMessage.

Returns a Vec<GossipEvent> describing what happened:

  • DuplicateDropped if the message was already seen.
  • MessageReceived + MessageForwarded if accepted and forwarded.
  • MessageReceived only if there are no eligible forward peers.
Source

pub fn select_peers( &mut self, exclude: &str, strategy: &FanoutStrategy, ) -> Vec<String>

Select peers to forward a message to, applying the given strategy.

The returned list excludes exclude (the origin peer) and only contains active peers.

Source

pub fn update_peer_score(&mut self, peer_id: &str, delivered: bool)

Update a peer’s fanout_score using an EMA with α = 0.1.

delivered = true → positive signal (score nudges toward 1.0). delivered = false → negative signal (score nudges toward 0.0).

Source

pub fn pending_messages(&self) -> usize

Number of message IDs currently in the dedup cache.

Source

pub fn stats(&self) -> GossipStats

Return a snapshot of current statistics.

Source

pub fn drain_events(&mut self) -> Vec<GossipEvent>

Drain and return all buffered GossipEvents.

Source

pub fn config(&self) -> &GossipConfig

Borrow the current configuration.

Source

pub fn peer_count(&self) -> usize

Number of registered peers (active + inactive).

Source

pub fn peer(&self, peer_id: &str) -> Option<&GossipPeer>

Get a peer by ID.

Source

pub fn deactivate_peer(&mut self, peer_id: &str) -> Result<(), EngineError>

Mark a peer as inactive without removing it.

Source

pub fn reactivate_peer(&mut self, peer_id: &str) -> Result<(), EngineError>

Reactivate a previously deactivated peer.

Source

pub fn clear_dedup_cache(&mut self)

Reset the dedup cache without touching any other state.

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