| GENERAL DESCRIPTION |
This describes the Broker RPCs that are used in support
of running a RPC as a background task.
This RPC will return a HANDLE that can be used to check if the data has
returned. The HANDLE can be used in another RPC to check the status of the
RPC.
XWB DEFERRED RPC
This is the RPC that is called to request that a RPC be run through taskman
in the background.
Parameters:
(rpc name[^rpc version],[1 to 10 params to the RPC])
Return:
The return value is always an array. The first node of the array is equal
to a string that serves as a HANDLE. This is used to check the status of a RPC
request and to retrieve the results of the RPC.
In the case of an error condition, the first node of the array is equal to a
string with the syntax "-1^error text".
XWB DEFERRED STATUS
This RPC will return the status of a deferred RPC.
Parameters:
The HANDLE from the XWB DEFERRED RPC.
Return:
The return value is always an array. The first node of the array is equal to
one of the following values:
"-1^Bad Handle" - An invalid handle has been passed.
"0^New" - The request has been sent.
"0^Running" - RPC is still processing
"1^Done" - RPC has completed and the data has returned to the local
server. The data is not returned by this RPC. Use the XWB REMOTE
GETDATA RPC to retrieve the data.
XWB DEFERRED GETDATA
This RPC is used to return the data from the XWB DEFERRED RPC call.
Parameters:
The HANDLE from the XWB DEFERRED RPC. It is used to link the call to the
data.
Return:
The return value is the array of data. In the event of an error
condition, the first node of the array is equal to a string with the
syntax "-1^error text".
XWB DEFERRED CLEAR
This RPC is used to CLEAR the data under the HANDLE in the ^XTMP global.
Parameters:
The HANDLE from the XWB DEFERRED RPC.
Return:
The return value is always an array. The first node of the array is
equal to 1.
XWB DEFERRED CLEARALL
This RPC is used to CLEAR ALL the data known to this job in the ^XTMP
global. Makes use of the list in ^TMP("XWBHDL",$J,handle).
Return:
The return value is always an array. The first node of the array is
equal to 1.
|