HP-UX SNAplus2 R7 LUA Programmer's Guide

RUI Verbs

RUI_PURGE

4.3.4 Usage and Restrictions

The RUI_INIT_PRIMARY verb completes after an ACTLU positive response is received from the downstream

LU. If necessary, the verb waits indeﬁnitely. If the application needs to check the contents of this ACTLU

positive response, it can do so by supplying a data buffer on RUI_INIT_PRIMARY (using the

lua_max_length and

lua_data_ptr parameters) in which SNAplus2 returns the contents of the received message.

Once the RUI_INIT_PRIMARY verb has completed successfully, this session uses the LU for which the session

was started. No other LUA session (from this or any other application) can use the LU until the RUI_TERM verb

is issued, or until an

LUA_SESSION_FAILURE

primary return code is received.

If the RUI_INIT_PRIMARY verb returns with an

LUA_IN_PROGRESS

primary return code then the Session ID

will be returned in the lua_sid parameter. This Session ID is the same as that returned when the verb completes

successfully and can be used with the RUI_TERM verb to terminate an outstanding RUI_INIT_PRIMARY verb.

4.4 RUI_PURGE

The RUI_PURGE verb cancels a previous RUI_READ. An RUI_READ may wait indeﬁnitely if it is sent without

using the lua_ﬂag1.nowait (immediate return) option, and no data is available on the speciﬁed ﬂow; RUI_PURGE

forces the waiting verb to return (with the primary return code

LUA_CANCELLED).

4.4.1 Supplied Parameters

The application supplies the following parameters:

lua_verb

LUA_VERB_RUI

lua_verb_length

The length in bytes of the LUA verb record.

Set this to sizeof(LUA_COMMON).

lua_opcode

LUA_OPCODE_RUI_PURGE

lua_correlator

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.

lua_luname

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 or RUI_INIT_PRIMARY 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.

lua_sid

The session ID of the session. This must match a session ID returned on a previous RUI_INIT or

RUI_INIT_PRIMARY verb.