Skip to main content

SubscriptionRouter

Struct SubscriptionRouter 

Source
pub struct SubscriptionRouter {
    pub total_routed: u64,
    pub total_delivered: u64,
    pub total_dropped: u64,
    /* private fields */
}
Expand description

Topic/type-based message routing engine.

Manages subscriber registrations, evaluates SubscriptionFilter predicates, logs delivery attempts to a bounded ring-buffer, and exposes rich query and eviction helpers.

§Design

  • Messages with ttl == 0 on arrival are immediately dropped (counted in total_dropped); their TTL is not decremented because the router does not modify the caller-owned message.
  • The delivery log is a VecDeque capped at max_log_size. Oldest entries are evicted when the cap is reached.
  • All statistics counters are plain u64 fields (not atomic) because the router is designed for single-threaded or externally-synchronized use. Wrap in Arc<Mutex<_>> if concurrent access is required.

Fields§

§total_routed: u64

Total messages passed to route.

§total_delivered: u64

Total successful deliveries.

§total_dropped: u64

Total dropped messages.

Implementations§

Source§

impl SubscriptionRouter

Source

pub fn new(max_log_size: usize) -> Self

Create a new SubscriptionRouter with a delivery log bounded at max_log_size entries.

Source

pub fn subscribe( &mut self, peer_id: String, topic: MessageTopic, filter: SubscriptionFilter, now: u64, ) -> u64

Register a subscription and return its stable ID.

If a subscription with the same derived ID already exists it is silently replaced.

Source

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

Remove the subscription with the given subscription_id.

Returns true if a subscription was found and removed, false if none existed with that ID.

Source

pub fn route(&mut self, message: &RoutingMessage, now: u64) -> Vec<u64>

Route message to all matching subscriptions.

Rules applied in order:

  1. If message.ttl == 0 the message is immediately dropped (counted in total_dropped); an empty Vec is returned.
  2. For every subscription, Self::matches is called. Matching subscriptions have their message_count incremented and receive a successful DeliveryRecord.
  3. If no subscriptions match, total_dropped is incremented and a failing DeliveryRecord with subscription_id = 0 is appended.

Returns the list of subscription IDs that were delivered to.

Source

pub fn matches(sub: &Subscription, msg: &RoutingMessage) -> bool

Return true when sub’s topic matches msg’s topic and the subscription’s filter accepts the message.

This is a pub method as required by the specification.

Source

pub fn filter_matches(filter: &SubscriptionFilter, msg: &RoutingMessage) -> bool

Recursively evaluate filter against msg.

This is a pub method as required by the specification.

Source

pub fn subscriptions_for_topic( &self, topic: &MessageTopic, ) -> Vec<&Subscription>

Return references to all active subscriptions for topic.

Source

pub fn subscriptions_for_peer(&self, peer_id: &str) -> Vec<&Subscription>

Return references to all subscriptions owned by peer_id.

Source

pub fn delivery_rate(&self, since: u64) -> f64

Compute the delivery rate over records whose delivered_at >= since.

Returns 1.0 when there are no matching records.

Source

pub fn recent_deliveries(&self, n: usize) -> Vec<&DeliveryRecord>

Return references to the n most-recent delivery records.

If fewer than n records exist, all are returned.

Source

pub fn evict_stale_subscriptions(&mut self, max_age_ms: u64, now: u64) -> usize

Remove subscriptions that have never delivered a message and were created more than max_age_ms milliseconds before now.

Returns the number of subscriptions evicted.

Source

pub fn stats(&self, now: u64) -> SubRouterStats

Return a SubRouterStats snapshot computed at the given logical now timestamp (used only for the delivery_rate calculation).

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