Struct Queue

pub struct Queue<S, C> { /* private fields */ }

A single queue, holding two subqueues (sending and completion). Objects of type S are sent across the sending queue, and completions of type C are sent back.

Implementations

impl<S: Copy, C: Copy> Queue<S, C>

pub fn object(&self) -> &Object<QueueBase<S, C>>

Get a handle to the internal object that holds the queue data.

pub fn create( create_spec: &CreateSpec, sub_queue_len: usize, com_queue_len: usize, ) -> Result<Self, CreateError>

Create a new Twizzler queue object.

pub fn submit( &self, id: u32, item: S, flags: SubmissionFlags, ) -> Result<(), QueueError>

Submit an item of type S across the sending subqueue, with a given id.

pub fn receive(&self, flags: ReceiveFlags) -> Result<(u32, S), QueueError>

Receive an item and request id from the sending subqueue.

pub fn complete( &self, id: u32, item: C, flags: SubmissionFlags, ) -> Result<(), QueueError>

Submit a completion item of type C across the completion subqueue.

pub fn get_completion( &self, flags: ReceiveFlags, ) -> Result<(u32, C), QueueError>

Receive a completion item and id from the completion subqueue.

pub fn setup_read_com_sleep(&self) -> ThreadSyncSleep

Setup a sleep operation for reading the completion subqueue.

pub fn setup_read_sub_sleep(&self) -> ThreadSyncSleep

Setup a sleep operation for reading the sending subqueue.

pub fn setup_write_sub_sleep(&self) -> ThreadSyncSleep

Setup a sleep operation for writing the sending subqueue.

pub fn setup_write_com_sleep(&self) -> ThreadSyncSleep

Setup a sleep operation for writing the completion subqueue.

Trait Implementations

impl<S: Copy, C: Copy> From<Object<QueueBase<S, C>>> for Queue<S, C>

fn from(x: Object<QueueBase<S, C>>) -> Self

Converts to this type from the input type.