| Name | Type | Deprecated | Secure | Description |
|---|
| Command.Queue.Handler | function | | | Sets the queue handler function. The queue handler function will be called when a Command.* funct... |
| Event.Queue.Status | | | | Signals that a queue may have left or entered the throttled state. |
| Inspect.Queue.Handler | function | | | Returns the current queue handler function. |
| Inspect.Queue.Status | function | | | Inspects the current queue status. Omit the first parameter to get a table containing information... |
Sets the queue handler function. The queue handler function will be called when a Command.* function is called which relies on a queue for throttling and that queue is full. This function will be passed (queue, owner, func, ...). queue: The identifier of the queue that this function call will wait on. owner: The identifier of the addon that made the function call. func: The function call that has been queued. ...: The argument list that must be passed to func.
Usage:
| Command.Queue.Handler(handler) |
| Parameter | Type | Datatype | Description |
|---|
| handler | parameter | function | The new queue handler. |
Signals that a queue may have left or entered the throttled state.
Usage:
| Event.Queue.Status(id) |
| Parameter | Type | Datatype | Description |
|---|
| id | parameter | variant | The ID of the queue affected. To get the actual new state, use Inspect.Queue.Status(). |
Returns the current queue handler function.
Usage:
| handler, owner = Inspect.Queue.Handler() |
| Parameter | Type | Datatype | Description |
|---|
| handler | result | function | The current queue handler function. |
| owner | result | string | The owner of the current queue handler function. |
Inspects the current queue status. Omit the first parameter to get a table containing information on all queues.
Usage:
| 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. |