HP-UX SNAplus2 R7 LUA Programmer's Guide

RUI Verbs

RUI_INIT_PRIMARY

A pointer to a callback routine. If the verb completes asynchronously, LUA will call this routine to indicate

completion of the verb. For more information, see Chapter 2, Designing and Writing LUA Applications.

lua_encr_decr_option

Session-level cryptography option. SNAplus2 accepts the following two values:

Session-level cryptography is not used.

128

Encryption and decryption are performed by the application program.

Any other value will result in the return code

LUA_ENCR_DECR_LOAD_ERROR. (Values in the range 1 to 127,

indicating user-deﬁned encryption and decryption routines, are supported by OS/2 Extended Edition’sLUA

implementation but not by SNAplus2.)

4.3.2 Returned Parameters

LUA always returns the following parameter:

lua_ﬂag2.async

This ﬂag is set to

1 if the verb completed asynchronously, or

0 if the verb completed synchro-

nously. (RUI_INIT_PRIMARY will always complete asynchronously, unless it returns an error such as

LUA_PARAMETER_CHECK.)

Other returned parameters depend on whether the verb completed successfully; see the following sections.

Successful Execution

If the verb executes successfully, LUA returns the following parameters.

lua_prim_rc

LUA_OK

lua_sid

A session ID for the new session. This can be used by subsequent verbs to identify this session.

lua_data_length

The length of the ACTLU(+RSP) RU received from the downstream PU. LUA places the data in the buffer

speciﬁed by lua_data_ptr.

Unsuccessful Execution

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 speciﬁc details about the reason for unsuccessful execution.

Verb Canceled

The following return codes indicate that the verb did not complete successfully because it was canceled by another

verb:

lua_prim_rc

LUA_CANCELLED

lua_sec_rc

LUA_TERMINATED

An RUI_TERM verb was issued before the RUI_INIT_PRIMARY had completed.