Back to index...

NameTypeDeprecatedSecureDescription
Command.Queue.HandlerfunctionSets the queue handler function. The queue handler function will be called when a Command.* funct...
Event.Queue.StatusSignals that a queue may have left or entered the throttled state.
Inspect.Queue.HandlerfunctionReturns the current queue handler function.
Inspect.Queue.StatusfunctionInspects the current queue status. Omit the first parameter to get a table containing information...

Command.Queue.Handler

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)
ParameterTypeDatatypeDescription
handlerparameterfunctionThe new queue handler.

Event.Queue.Status

Signals that a queue may have left or entered the throttled state.

Usage:

Event.Queue.Status(id)
ParameterTypeDatatypeDescription
idparametervariantThe ID of the queue affected. To get the actual new state, use Inspect.Queue.Status().

Inspect.Queue.Handler

Returns the current queue handler function.

Usage:

handler, owner = Inspect.Queue.Handler()
ParameterTypeDatatypeDescription
handlerresultfunctionThe current queue handler function.
ownerresultstringThe owner of the current queue handler function.

Inspect.Queue.Status

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)
ParameterTypeDatatypeDescription
queueparameterstringOptional identifier of the queue to query. Valid values include "global" and "auctionfullscan".
sizeparameternumberThe size of the element to test in this queue. Defaults to 1 if no size is provided.
resultresultbooleanfalse if this queue is throttled, non-false otherwise.
resultsresulttableA 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.

Back to index...