Sender

Struct Sender 

Source
pub struct Sender<T, const P: usize, const NUM_SEGS_P2: usize> { /* private fields */ }
Expand description

Blocking MPMC Queue - Multi-Producer Single-Consumer with blocking operations

§Type Parameters

  • T: The type of elements stored in the queue (must be Copy)
  • P: log2 of segment size (default 8 = 256 items/segment)
  • NUM_SEGS_P2: log2 of number of segments (default 2 = 4 segments, total capacity ~1024)

§Examples

use bop_mpmc::mpsc_blocking::MpscBlocking;
use std::thread;
use std::time::Duration;

let mpsc = MpscBlocking::<i32>::new();

// Producer thread
let mpsc_producer = mpsc.clone();
thread::spawn(move || {
    thread::sleep(Duration::from_millis(100));
    mpsc_producer.push(42).unwrap();
});

// Consumer blocks until item is available
let value = mpsc.pop_blocking().unwrap();
assert_eq!(value, 42);
```ignore

Implementations§

Source§

impl<T, const P: usize, const NUM_SEGS_P2: usize> Sender<T, P, NUM_SEGS_P2>

Source

pub fn is_closed(&self) -> bool

Check if the queue is closed

Source

pub fn producer_count(&self) -> usize

Get the number of registered producers

Source

pub fn producer_id(&self) -> usize

Get the producer ID for this handle

Source

pub fn try_push(&mut self, value: T) -> Result<(), PushError<T>>

Push a value onto the queue

This will use the thread-local SPSC queue for this producer. If successful, notifies any waiting consumer.

Source

pub fn push_spin(&mut self, value: T) -> Result<(), PushError<T>>

Push a value onto the queue (spins if full)

This will use the thread-local SPSC queue for this producer. If successful, notifies any waiting consumer.

Source

pub fn try_push_n(&mut self, values: &[T]) -> Result<usize, PushError<()>>

Push multiple values in bulk

Source

pub unsafe fn unsafe_try_push(&self, value: T) -> Result<(), PushError<T>>

Push a value onto the queue

This will use the thread-local SPSC queue for this producer. If successful, notifies any waiting consumer.

Source

pub unsafe fn unsafe_try_push_n( &self, values: &[T], ) -> Result<usize, PushError<()>>

Push multiple values in bulk

Source

pub fn close(&mut self) -> bool

Close the queue

After closing, no more items can be pushed. This method will block until all SPSC queues are empty. Wakes any waiting consumer.

Note: This waits for consumer to drain all items from all producer queues.

Trait Implementations§

Source§

impl<T, const P: usize, const NUM_SEGS_P2: usize> Clone for Sender<T, P, NUM_SEGS_P2>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<T, const P: usize, const NUM_SEGS_P2: usize> Drop for Sender<T, P, NUM_SEGS_P2>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<T, const P: usize, const NUM_SEGS_P2: usize> Freeze for Sender<T, P, NUM_SEGS_P2>

§

impl<T, const P: usize, const NUM_SEGS_P2: usize> !RefUnwindSafe for Sender<T, P, NUM_SEGS_P2>

§

impl<T, const P: usize, const NUM_SEGS_P2: usize> Send for Sender<T, P, NUM_SEGS_P2>

§

impl<T, const P: usize, const NUM_SEGS_P2: usize> Sync for Sender<T, P, NUM_SEGS_P2>

§

impl<T, const P: usize, const NUM_SEGS_P2: usize> Unpin for Sender<T, P, NUM_SEGS_P2>

§

impl<T, const P: usize, const NUM_SEGS_P2: usize> !UnwindSafe for Sender<T, P, NUM_SEGS_P2>

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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