Inspects the current queue status. Omit the first parameter to get a table containing information on all queues.
| results = Inspect.Queue.Status() | |||
| result = Inspect.Queue.Status(queue) | |||
| results = Inspect.Queue.Status(queue, size) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| queue | parameter | string | Optional identifier of the queue to query. Valid values include "global" and "auctionfullscan". |
| size | parameter | number | The size of the element to test in this queue. Defaults to 1 if no size is provided. |
| result | result | boolean | false if this queue is throttled, non-false otherwise. |
| results | result | table | A key/value table. The first parameter is the name of the queue. The second parameter is false if the queue is throttled, or a number representing the queue size available otherwise. |