The f=qt-list Function
This function returns information about queued transactions. By default, the report returns information about all queued transactions and about every queue, and it can filter for transactions that are queued, executing, cancelled, or complete.
|
|
This function is different from the rest of the queued transaction management functions beginning with qt- in the set of parameters it supports.
|
It takes the following parameters:
• hostname
Specifies the host name of the client that submitted the transaction
• ip
Specifies the IP address of the client that submitted the transaction
• userid
Specifies the ID of user who submitted the transaction
• id
Specifies the name of the queue for the transaction
You may specify all queues id=*or by omitting the id parameter.
• state
Specifies the state of the transaction, queued, executing, cancelled or complete.
Each parameter may be omitted, specified once, or specified more than once. If a parameter is omitted, then transactions are not filtered with regard to that parameter. If a parameter is specified, then only transactions that match that parameter value are returned. If a parameter is specified more than once, then transactions that match either of the parameter specification are returned.
For example, if the state parameter is not specified, then all transactions are not filtered for their state. If state=complete is specified, then only completed transactions are returned. If state=complete and state=queued are both specified, then queued and completed transactions are returned.
If two different parameters are specified more than once each, then transactions matching the combinations of both parameter values are returned. For example, request specifies:
f=qt-list&id=queue1&id=queue2&state=complete&state=queued
Only transactions on either queue1 or queue2 and with a state of either queued or complete are returned.
