Skip to main content

NetworkEventBus

Struct NetworkEventBus 

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

Synchronous in-process publish-subscribe bus for NetworkEvents.

§Example

use ipfrs_network::event_bus::{NetworkEventBus, NetworkEvent, EventFilter};

let mut bus = NetworkEventBus::new();
let id = bus.subscribe(EventFilter::PeerEvents);

bus.publish(NetworkEvent::PeerConnected {
    peer_id: "peer1".into(),
    address: "/ip4/1.2.3.4/tcp/4001".into(),
});

let events = bus.drain(id);
assert_eq!(events.len(), 1);

Implementations§

Source§

impl NetworkEventBus

Source

pub fn new() -> Self

Create a new, empty NetworkEventBus.

Source

pub fn subscribe(&mut self, filter: EventFilter) -> u64

Subscribe to events matching filter.

Returns a unique subscription id that can be used to drain events or unsubscribe later.

Source

pub fn unsubscribe(&mut self, id: u64) -> bool

Remove the subscription identified by id.

Returns true if the subscription existed, false otherwise.

Source

pub fn publish(&mut self, event: NetworkEvent)

Publish an event to all matching subscribers.

Each matching subscriber receives its own clone of event. If a subscriber’s queue is full (>= 200 entries) the event is dropped and both the per-subscription and global drop counters are incremented.

Source

pub fn drain(&mut self, id: u64) -> Vec<NetworkEvent>

Drain all buffered events for the subscription identified by id.

Returns an empty Vec if the id does not exist.

Source

pub fn peek_count(&self, id: u64) -> usize

Return the number of events currently buffered for subscription id.

Returns 0 for unknown ids.

Source

pub fn stats(&self) -> BusStats

Return a snapshot of the current bus statistics.

Source

pub fn clear_all_queues(&mut self)

Drain all queues for all active subscriptions, discarding pending events.

Trait Implementations§

Source§

impl Debug for NetworkEventBus

Source§

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

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

impl Default for NetworkEventBus

Source§

fn default() -> NetworkEventBus

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