The ECI_STATE_ASYNC call type provides an asynchronous status information call. The calling application gets control back when the ECI accepts the request. At this point the parameters have been validated; however, the request might still be queued for later processing.
If no callback routine is provided, the application must use a reply solicitation call to determine that the request has ended and what the outcome was.
If a callback routine is provided, the callback routine eci_callback is invoked when a response is available.
Must be set to ECI_STATE_ASYNC.
A pointer to the area of storage where the application receives the returned COMMAREA containing status information. See Status information calls, in the External call interface chapter, in CICS Transaction Gateway: Programming Guide, and ECI status block, for more details.
If eci_extend_mode has the value ECI_STATE_CANCEL, supply a null pointer and set the length (specified in eci_commarea_length) to zero.
The length of the COMMAREA in bytes, which must be the length of the ECI_STATUS structure that gives the layout of the status information COMMAREA. See Status information calls, in the External call interface chapter, in CICS Transaction Gateway: Programming Guide, and ECI status block, for more details. Area size must not exceed 32 500 bytes
If no COMMAREA is required, set this field to zero and supply a null pointer in eci_commarea.
This field was previously eci_system_ return_code. In the CICS® Transaction Gateway Version 3.1, and higher, this field is reserved for compatibility with earlier versions. No information is returned in this field; all system errors are written to the error log.
An integer field allowing you to identify each asynchronous call if you are making more than one. If a callback routine is specified, the value in this field is returned to the callback routine during the notification process.
When a deferred status request is being set up (eci_extend_mode set to ECI_STATE_CHANGED), the token identifying the request is returned in the eci_luw_token field.
When a deferred status request is being cancelled (eci_extend_mode set to ECI_STATE_CANCEL), the eci_luw_token field must contain the token that was received during the ECI_STATE_CHANGED call.
This field is not used when other values of eci_extend_mode are specified.
Reserved for future use, but this field should be initialized with nulls before the start of each logical unit of work.
The version of the ECI for which the application is coded. Use the value ECI_VERSION_1A.
An 8-character field that specifies the name of the server for which status information is requested. Pad unused characters with spaces. If supplied, it should be one of the server names returned by CICS_EciListSystems. The value may be supplied whenever eci_luw_token is set to zero.
If the field is set to nulls, the default server is selected.You can find out the name of the server from the eci_system_name field of the reply solicitation call you use to get the result of this asynchronous request. field.
A pointer to the routine to be called when the asynchronous request completes. (The callback routine will be called only if the return code is ECI_NO_ERROR, and the pointer is not null.)
See also the general list of return codes for CICS_ExternalCall in CICS_ExternalCall ECI_Parms.