|
|
|
|
The RUI_PURGE verb cancels a previous RUI_READ. An RUI_READ may wait indefinitely if it is sent without using the lua_flag1.nowait (immediate return) option, and no data is available on the specified flow; RUI_PURGE forces the waiting verb to return (with the primary return code LUA_CANCELLED).
The application supplies the following parameters:
The length in bytes of the LUA verb record.
Set this to sizeof(struct LUA_COMMON).
Optional. A four-byte value that you can use to correlate this verb with other processing within your application. LUA does not use or change this information.
The name in ASCII of the LU used by the session. This must match the LU name of an active LUA session, as returned on the RUI_INIT verb.
This parameter is required only if the lua_sid parameter is 0 (zero). If a session ID is supplied in lua_sid, LUA does not use this parameter.
This parameter must be eight bytes long; pad on the right with spaces, 0x20, if the name is shorter than eight characters.
The session ID of the session. This must match a session ID returned on a previous RUI_INIT verb.
This parameter is optional; if you do not specify the session ID, you must specify the LU name for the session in the lua_luname parameter.
A pointer to the RUI_READ VCB that is to be purged.
A pointer to a callback routine that LUA will call to indicate completion if the verb completes asynchronously.
If the VCB is used in a RUI function call, set this field to an event handle. If the VCB is used in a WinRUI function call, this field is reserved.
For more information, see Designing and Writing LUA Applications.
LUA always returns the following parameter:
This flag is set to 1 if the verb completed asynchronously, or 0 (zero) if the verb completed synchronously.
Other returned parameters depend on whether the verb completed successfully; see the following sections.
If the verb completed successfully, the following parameters are returned:
LUA_OK
If the application specified the lua_luname parameter when issuing this verb, rather than specifying the session ID, LUA supplies the session ID.
If a verb does not complete successfully, LUA returns a primary return code to indicate the type of error and a secondary return code to provide specific details about the reason for unsuccessful execution.
The following return codes indicate that the verb did not complete successfully because it was canceled by another verb:
LUA_CANCELLED
An RUI_TERM verb was issued while this verb was pending.
The following return codes indicate that the verb did not complete successfully because a supplied parameter was in error:
LUA_PARAMETER_CHECK
Possible values are:
The lua_data_ptr parameter was set to 0 (zero).
The lua_sid parameter did not match the session ID of any active LUA LU session.
The lua_post_handle parameter was not a valid pointer to a callback routine.
A reserved field in the verb record, or a parameter that is not used by this verb, was set to a nonzero value.
The value of the lua_verb_length parameter was less than the length of the verb record required for this verb.
The following return codes indicate that the verb was issued in a session state in which it was not valid:
LUA_STATE_CHECK
An RUI_INIT verb has not yet completed successfully for the LU name specified on this verb, or the session has failed.
The following return codes indicate that the verb record supplied was valid, but the verb did not complete successfully:
LUA_UNSUCCESSFUL
Possible values are:
The operating system process that issued this verb was not the same process that issued the RUI_INIT verb for this session. Only the process that started a session can issue verbs on that session.
Either the lua_data_ptr parameter did not contain a pointer to an RUI_READ VCB, or the RUI_READ verb completed before the RUI_PURGE verb was issued.
The following return codes indicate that the verb did not complete successfully for other reasons:
A required SNAP-IX software component (such as the node) has terminated or has been stopped. Contact your System Administrator if necessary.
The LUA session has failed.
If the secondary return code is not LUA_RUI_LOGIC_ERROR , then this LU can be reinitialized using an RUI_REINIT. If it is not reinitialized, then an RUI_TERM must be issued before an RUI_INIT can be issued for the same LU.
Possible values are:
This return code indicates that the LUA session has failed because of a problem with the communications link or with the host LU.
This return code indicates one of the following:
The host system has violated SNA protocols
An internal error was detected within LUA
Attempt to reproduce the problem with SNA tracing active (contact your System Administrator if necessary), and check that the host is sending correct data. If this does not solve the problem, contact your SNAP-IX support personnel.
Either the lua_verb parameter or the lua_opcode parameter was not valid. The verb did not execute.
The stack size of the application is too small for LUA to complete the request. Increase the stack size of your application.
An operating system error occurred.
This value is the operating system return code. Check your operating system documentation for the meaning of this return code.
The node was either not started or not configured properly for LUA applications. Check the SNAP-IX LUA configuration parameters and start the node before running your application.
This verb can only be used when an RUI_READ has been issued and is pending completion (that is, the primary return code is IN_PROGRESS).
|
|
|
 |
|