CMSimpleQueue

init

static init(object: CMSimpleQueue): CMSimpleQueue

init(referencing object: CMSimpleQueue)

head

get head(): (SDKHandle) | null

var head: UnsafeRawPointer? { get }

Returns the element at the head of the queue. - Returns: The head element. nil if the queue was empty, or if there was some other error.

count

get count(): number

var count: Int { get }

The number of elements currently in the queue. Returns 0 if there is an error.

reset

reset(): void

func reset() throws

Resets the queue. This function resets the queue to its empty state; all values in the queue prior to reset are lost. Note that CMSimpleQueueReset is not synchronized in any way, so the reader thread and writer thread must be held off by the client during this operation.

typeID

static get typeID(): number

static var typeID: CFTypeID { get }

The `CFTypeID` corresponding to `CMSimpleQueue`. You can check if a CFTypeRef object is actually a CMSimpleQueue by comparing CFGetTypeID(object) with CMSimpleQueue.typeID.

dequeue

dequeue(): (SDKHandle) | null

func dequeue() -> UnsafeRawPointer?

Dequeues an element from the queue. - Returns: The dequeued element. nil if the queue was empty, or if there was some other error.

enqueue

enqueue(element: SDKHandle): void

func enqueue(_ element: UnsafeRawPointer) throws

Enqueues an element on the queue. If the queue is full, this operation will fail. - Parameter element: Element to enqueue.

capacity

get capacity(): number

var capacity: Int { get }

The number of elements that can be held in the queue. Returns 0 if there is an error.

fullness

get fullness(): number

var fullness: Float { get }

A convenience macro that returns GetCount/GetCapacity, computed in floating point. 0.0 is empty, 0.5 is half full, 1.0 is full. Returns 0.0 if there is an error