Struct SBQueue

pub struct SBQueue {
    pub raw: SBQueueRef,
}

A libdispatch (aka Grand Central Dispatch) queue.

A program using libdispatch will create queues, put work items (functions, blocks) on the queues. The system will create / reassign pthreads to execute the work items for the queues. A serial queue will be associated with a single thread (or possibly no thread, if it is not doing any work). A concurrent queue may be associated with multiple threads.

The available queues within a process can be found discovered by inspecting the process via SBProcess::queues():

// Iterate over the queues...
for queue in process.queues() {
    println!("Hello {}!", queue.queue_id());
}

If a queue is associated with a thread, it can be discovered from the thread via SBThread::queue().

Fields

raw: SBQueueRef

The underlying raw SBQueueRef.

Implementations

impl SBQueue

pub fn is_valid(&self) -> bool

Check whether or not this is a valid SBQueue value.

pub fn process(&self) -> SBProcess

pub fn queue_id(&self) -> u64

Returns a unique identifying number for this queue that will not be used by any other queue during this process’ execution.

These ID numbers often start at 1 with the first system-created queues and increment from there.

pub fn name(&self) -> &str

The name of this queue.

pub fn threads(&self) -> SBQueueThreadIter<'_>

Get an iterator over the threads associated with this queue.

pub fn pending_items(&self) -> SBQueueQueueItemIter<'_>

Get an iterator over the pending items known to this queue.

pub fn num_running_items(&self) -> u32

The number of work items that this queue is currently running.

For a serial queue, this will be 0 or 1. For a concurrent queue, this may be any number.

pub fn kind(&self) -> QueueKind

The kind of this queue, serial or concurrent.

Trait Implementations

impl Clone for SBQueue

fn clone(&self) -> SBQueue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Drop for SBQueue

fn drop(&mut self)

Executes the destructor for this type.

impl Send for SBQueue

impl Sync for SBQueue