Skip to main content

MulticastBuffer

Struct MulticastBuffer 

Source
pub struct MulticastBuffer<T> { /* private fields */ }
Expand description

Pre-allocated SPMC multicast buffer with reference-counted slots.

Provides zero-allocation publish/consume on the hot path. The buffer is constructed in Ring 2 and used in Ring 0.

§Type Parameters

  • T - The event type. Must be Clone for consumers (typically Arc<RecordBatch> where clone is an O(1) atomic increment).

§Performance Targets

OperationTarget
publish()< 100ns
consume()< 50ns

Implementations§

Source§

impl<T> MulticastBuffer<T>

Source

pub fn new(capacity: usize, consumer_count: usize) -> Self

Creates a new multicast buffer.

Allocates all slots up front (Ring 2). The hot path (publish/consume) is allocation-free.

§Arguments
  • capacity - Number of slots (must be a power of 2, > 0)
  • consumer_count - Number of downstream consumers
§Panics

Panics if capacity is not a power of 2 or is 0.

Source

pub fn publish(&self, value: T) -> Result<(), DagError>

Publishes a value to all consumers.

Writes the value into the next available slot and sets the refcount to consumer_count. All consumers will be able to read this value via consume().

§Errors

Returns DagError::BackpressureFull if the target slot is still in use by a slow consumer (backpressure).

§Safety Contract

Must be called from a single writer thread only. The DAG executor enforces this by assigning exactly one producer per shared stage.

Source

pub fn consume(&self, consumer_idx: usize) -> Option<T>
where T: Clone,

Consumes the next value for a given consumer.

Returns None if no new data is available. Each consumer maintains its own read position and will receive every published value in order.

§Arguments
  • consumer_idx - The consumer’s index (0-based, must be < consumer_count)
§Panics

Panics in debug mode if consumer_idx >= consumer_count.

Source

pub fn capacity(&self) -> usize

Returns the buffer capacity (number of slots).

Source

pub fn consumer_count(&self) -> u32

Returns the number of consumers.

Source

pub fn write_position(&self) -> u64

Returns the current write position (total number of publishes).

Source

pub fn read_position(&self, consumer_idx: usize) -> u64

Returns the current read position for a consumer.

§Panics

Panics if consumer_idx is out of bounds.

Trait Implementations§

Source§

impl<T> Debug for MulticastBuffer<T>

Source§

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

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

impl<T: Send> Send for MulticastBuffer<T>

Source§

impl<T: Send> Sync for MulticastBuffer<T>

Auto Trait Implementations§

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
§

impl<T> ArchivePointee for T

§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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
§

impl<T> LayoutRaw for T

§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
§

impl<T> Pointee for T

§

type Metadata = ()

The metadata type for pointers and references to this type.
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> Scope for T

§

fn with<F, R>(self, f: F) -> R
where Self: Sized, F: FnOnce(Self) -> R,

Scoped with ownership.
§

fn with_ref<F, R>(&self, f: F) -> R
where F: FnOnce(&Self) -> R,

Scoped with reference.
§

fn with_mut<F, R>(&mut self, f: F) -> R
where F: FnOnce(&mut Self) -> R,

Scoped with mutable reference.
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> Value for T
where T: Send + Sync + 'static,