Struct Queue

pub struct Queue { /* private fields */ }

Represents an open queue descriptor to a POSIX message queue. This carries information about the queue’s limitations (i.e. maximum message size and maximum message count).

Implementations

impl Queue

pub fn create( name: Name, max_pending: i64, max_size: i64, ) -> Result<Queue, Error>

Creates a new queue and fails if it already exists. By default the queue will be read/writable by the current user with no access for other users. Linux users can change this setting themselves by modifying the queue file in /dev/mqueue.

pub fn open(name: Name) -> Result<Queue, Error>

Opens an existing queue.

pub fn open_or_create(name: Name) -> Result<Queue, Error>

Opens an existing queue or creates a new queue with the OS default settings.

pub fn delete(self) -> Result<(), Error>

Delete a message queue from the system. This method will make the queue unavailable for other processes after their current queue descriptors have been closed.

pub fn send(&self, msg: &Message) -> Result<(), Error>

Send a message to the message queue. If the queue is full this call will block until a message has been consumed.

pub fn receive(&self) -> Result<Message, Error>

Receive a message from the message queue. If the queue is empty this call will block until a message arrives.

pub fn max_pending(&self) -> i64

pub fn max_size(&self) -> usize

Trait Implementations

impl Debug for Queue

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

Formats the value using the given formatter.

impl Drop for Queue

fn drop(&mut self)

Executes the destructor for this type.