FanoutRouter

Struct FanoutRouter 

Source
pub struct FanoutRouter<const N: usize> { /* private fields */ }
Expand description

Fanout router handle.

This is a single-step primitive; long-running routing loops live in indexbus-route.

Implementations§

Source§

impl<const N: usize> FanoutRouter<N>

Source

pub fn route_once_with(&self, source: RouterSource, mode: RouterMode) -> bool

Route a single event.

Returns true if an event was consumed from the source queue.

Ordering for a given consumer matches the router’s routing order.

Source

pub fn route_once_with_stats( &self, source: RouterSource, mode: RouterMode, ) -> RouteOnceResult

Route a single event and return delivery statistics.

Source

pub fn route_once_with_credit_masks( &self, source: RouterSource, mode: RouterMode, eligible_mask: u64, no_credit_mask: u64, full_mask: u64, ) -> RouteOnceCreditResult

Credit-aware routing step.

eligible_mask marks which consumers are eligible for delivery. no_credit_mask marks consumers that are explicitly ineligible due to exhausted credit. full_mask marks consumers whose destination queues are full.

The router will attempt to deliver only to eligible_mask consumers.

Source

pub fn as_ptr(&self) -> *mut SharedFanoutLayout<N>

Return the underlying shared-memory pointer.

This is intended for low-level integrations; callers must uphold the mapping lifetime.

Trait Implementations§

Source§

impl<const N: usize> Send for FanoutRouter<N>

Auto Trait Implementations§

§

impl<const N: usize> Freeze for FanoutRouter<N>

§

impl<const N: usize> !RefUnwindSafe for FanoutRouter<N>

§

impl<const N: usize> !Sync for FanoutRouter<N>

§

impl<const N: usize> Unpin for FanoutRouter<N>

§

impl<const N: usize> !UnwindSafe for FanoutRouter<N>

Blanket Implementations§

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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.