Asynchronous request object handle

Maintains the status of an asynchronous request running on an AppServer or Web service.

Syntax


`async-request-handle` [ : `attribute` ]

async-request-handle

A handle variable that references an asynchronous request object. This object is instantiated when you execute an asynchronous remote procedure using the RUN statement specified with the ASYNCHRONOUS option. You can get the handle value by doing one of the following:

Use the ASYNCHRONOUS SET option on the same RUN statement that instantiates the asynchronous request.

Reference the LAST-ASYNC-REQUEST attribute on the server handle for the AppServer where the request is running. To ensure that you are referencing a specific request, you must reference the attribute after the associated RUN statement executes and before you instantiate another asynchronous request on the same AppServer connection.

You can also locate the asynchronous request handle by walking the chain between the FIRST-ASYNC-REQUEST and LAST-ASYNC-REQUEST attributes of the associated server handle. Search on the PROCEDURE-NAME attribute of each request handle to identify the specific request.

attribute

An attribute of the asynchronous request handle.

Attributes


CANCELLED attribute	COMPLETE attribute	ERROR attribute
EVENT-PROCEDURE attribute	EVENT-PROCEDURE-CONTEXT attribute	HANDLE attribute
INSTANTIATING-PROCEDURE attribute	NAME attribute	NEXT-SIBLING attribute
PERSISTENT-PROCEDURE attribute	PREV-SIBLING attribute	PRIVATE-DATA attribute
PROCEDURE-NAME attribute	QUIT attribute	SERVER attribute
STOP attribute	TYPE attribute	–

Events


PROCEDURE-COMPLETE	–

Notes

When the AppServer completes and returns the results of the asynchronous request associated with this handle, the client application that executed the request receives the PROCEDURE-COMPLETE event. This event triggers execution of the associated event procedure (if specified) in the context of an I/O blocking statement, such as the WAIT-FOR statement, UPDATE statement, or a PROCESS EVENTS statement.

You can access this handle anywhere in the client application that executes the associated request. However, it is especially useful for reference in the event procedure for the asynchronous request. In the associated event procedure, you can access this handle as the value of the SELF system handle.

For more information on asynchronous requests, the PROCEDURE-COMPLETE event, and asynchronous request handles, see OpenEdge Application Server: Developing AppServer Applications.