Get Queue Status
- Updated2023-02-17
- 3 minute(s) read
Get Queue Status
Returns information about the current state of a queue, such as the number of elements currently in the queue.
Using this node in parallel code may result in race conditions. To avoid race conditions, use this node only for monitoring and not for controlling code.
Inputs/Outputs
queue
A reference to a queue.
return elements
A Boolean value that determines whether to return the elements in the queue.
| True | This node returns the elements in the queue. |
| False | This node does not return the elements in the queue. |
Default value: False
error in
Error conditions that occur before this node runs.
Default value: no error
max queue size
The maximum number of elements the queue can contain.
If max queue size is -1, the queue can contain an unlimited number of elements.
queue name
The name of the queue, if the queue is named.
queue out
Reference to the queue.
number pending remove
The number of Dequeue Element or Preview Queue Element nodes currently waiting to remove an element from the queue.
number pending insert
The number of Enqueue Element or Enqueue Element at Opposite End nodes currently waiting to insert an element in the queue.
If the maximum queue size is -1, this output returns 0.
error out
Error information.
The node produces this output according to standard error behavior.
number elements in queue
Current number of elements in the queue.
elements
An array of all the elements currently in the queue.
If return elements? is set to False, this output returns an empty array.
The data type of the array elements changes to match the data type of the queue elements.
Programming Patterns
Transferring Data Between Loops Using Queue Nodes
Verifying Valid Queue References
You can use Get Queue Status to verify that a queue reference is valid. If a queue reference is not valid, this node returns error code 1.