Table Of Contents

Get Queue Status (G Dataflow)

Last Modified: January 9, 2017

Returns information about the current state of a queue, such as the number of elements currently in the queue.

connector_pane_image
datatype_icon

queue

Reference to a queue. Use Obtain Queue to obtain a queue reference.

datatype_icon

return elements? (F)

A Boolean that specifies whether to return the elements in the queue.

TRUE Returns the elements in the queue.
FALSE Does not return the elements in the queue.

Default: FALSE

datatype_icon

error in

Error conditions that occur before this node runs.

This node runs normally even if an error occurred before this node runs. Otherwise, the node responds to this input according to standard error behavior.

datatype_icon

max queue size

The maximum number of elements the queue can contain. If max queue size is -1, the queue can contain any number of elements.

spd-note-note
Note  

This input only limits the number of elements in the queue. It does not preallocate that number of elements in the queue.

datatype_icon

queue name

The name of the queue.

datatype_icon

queue out

Reference to the queue unchanged.

datatype_icon

number pending remove

The number of Dequeue Element or Preview Queue Element nodes currently waiting to remove an element from the queue.

Refer to the Dequeue Element and Preview Queue Element nodes for more information.

datatype_icon

number pending insert

The number of nodes currently waiting to insert an element in the queue. Use the Enqueue Element or Enqueue Element at Opposite End nodes to insert an element in the queue. If the max queue size is -1, # pending insert this output is 0.

datatype_icon

error out

Error information. The node produces this output according to standard error behavior.

datatype_icon

number elements in queue

Current number of elements in the queue.

datatype_icon

elements

All the elements currently in the queue. If return elements? is FALSE, this array is empty. This data type changes to match the subtype of queue.

Where This Node Can Run:

Desktop OS: Windows

FPGA: Not supported


Recently Viewed Topics