ShmSequencedSlotsSubscriber

Struct ShmSequencedSlotsSubscriber 

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

Subscriber/consumer that reads from the cursor and advances a specific gating sequence.

This is the multi-consumer (multicast) building block.

Implementations§

Source§

impl ShmSequencedSlotsSubscriber

Source

pub fn attach( opts: &AttachOptions, lane: &str, consumer: usize, ) -> Result<Self, BackingError>

Attach a subscriber for consumer.

Source

pub fn recv_next_into<W: WaitStrategy>( &mut self, cursor: &CursorBarrier, wait: &mut W, out: &mut [u8], ) -> Result<(u64, usize), SequencedSlotsError>

Receive the next sequenced entry into out, advancing gating and releasing the slot.

Source

pub fn recv_next_into_from<W: WaitStrategy, B: SeqBarrier>( &mut self, barrier: &B, wait: &mut W, out: &mut [u8], ) -> Result<(u64, usize), SequencedSlotsError>

Receive the next sequenced entry into out, waiting on an arbitrary SeqBarrier.

This is the building block for stage-ordered consumption (e.g. consumer waits on the last stage’s gating sequence, or on a join barrier).

Source

pub fn recv_next_into_stoppable<W: WaitStrategy>( &mut self, cursor: &CursorBarrier, wait: &mut W, out: &mut [u8], stop: &AtomicBool, ) -> Result<(u64, usize), SequencedSlotsError>

Stop-aware variant of Self::recv_next_into.

Source

pub fn recv_next_into_from_stoppable<W: WaitStrategy, B: SeqBarrier>( &mut self, barrier: &B, wait: &mut W, out: &mut [u8], stop: &AtomicBool, ) -> Result<(u64, usize), SequencedSlotsError>

Stop-aware variant of Self::recv_next_into_from.

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