Struct Queue 

pub struct Queue<T: Copy + Sized> { /* private fields */ }

A type-safe message queue for communicating between tasks within an application.

The type T must be Copy and Sized to be sent over the queue, as the underlying OSAL API works with raw byte copies.

Implementations

impl<T: Copy + Sized> Queue<T>

pub fn new(name: &str, depth: usize) -> Result<Self>

Creates a new message queue.

Arguments

• name: A unique string to identify the queue.
• depth: The maximum number of messages the queue can hold.

pub fn put(&self, message: &T) -> Result<()>

Puts a message onto the queue.

This operation is non-blocking. If the queue is full, an error is returned.

Arguments

• message: A reference to the message data to send.

pub fn get(&self, timeout_ms: i32) -> Result<T>

Retrieves a message from the queue.

This operation can block until a message is available, depending on the timeout.

Arguments

• timeout_ms: Timeout in milliseconds. Can be a positive value, ffi::OS_CHECK (0) for a non-blocking poll, or ffi::OS_PEND (-1) to block indefinitely.

pub fn id(&self) -> OsalId

Returns the underlying OSAL ID of the queue.

pub fn get_id_by_name(name: &str) -> Result<OsalId>

Finds an existing queue ID by its name.

pub fn get_info(&self) -> Result<QueueProp>

Retrieves information about this queue.

Trait Implementations

impl<T: Debug + Copy + Sized> Debug for Queue<T>

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

Formats the value using the given formatter.

impl<T: Copy + Sized> Drop for Queue<T>

fn drop(&mut self)

Deletes the OSAL queue when the Queue object goes out of scope.