Asynchronous Actions
When you send an asynchronous action, the connector adds the task to a queue and returns a token. The connector performs the task when a thread becomes available. You can use the token with the QueueInfo action to check the status of the action and retrieve the results of the action.
Most of the features provided by the connector are available through action=fetch, so when you use the QueueInfo action, query the fetch action queue, for example:
/action=QueueInfo&QueueName=Fetch&QueueAction=GetStatus
Check the Status of an Asynchronous Action
To check the status of an asynchronous action, use the QueueInfo action, providing the token that was returned.
To check the status of an asynchronous action
-
Send the
QueueInfoaction to Objective Connector with the following parameters.QueueNameThe name of the action queue that you want to check. QueueActionThe action to perform. Set this parameter to GetStatus.Token(Optional) The token that the asynchronous action returned. If you do not specify a token, Objective Connector returns the status of every action in the queue.
For example:
/action=QueueInfo&QueueName=fetch&QueueAction=getstatus&Token=...
Cancel an Asynchronous Action that is Queued
To cancel an asynchronous action that is waiting in a queue, use the following procedure.
To cancel an asynchronous action that is queued
-
Send the
QueueInfoaction to Objective Connector with the following parameters.QueueNameThe name of the action queue that contains the action to cancel. QueueActionThe action to perform . Set this parameter to Cancel.TokenThe token that the asynchronous action returned.
For example:
/action=QueueInfo&QueueName=fetch&QueueAction=Cancel&Token=...
Stop an Asynchronous Action that is Running
You can stop an asynchronous action at any point.
To stop an asynchronous action that is running
-
Send the
QueueInfoaction to Objective Connector with the following parameters.QueueNameThe name of the action queue that contains the action to stop. QueueActionThe action to perform. Set this parameter to Stop.TokenThe token that the asynchronous action returned.
For example:
/action=QueueInfo&QueueName=fetch&QueueAction=Stop&Token=...