HP-UX SNAplus2 R7 LUA Programmer's Guide

RUI Verbs
RUI_BID
4 RUI Verbs
This chapter contains a description of each LUA RUI verb. The following information is provided for each verb:
• Purpose of the verb.
• Parameters (VCB fields) supplied to and returned by LUA. The description of each parameter includes
information about the valid values for that parameter, and any additional information necessary.
• Interaction with other verbs.
• Additional information describing the use of the verb.
For details of the Verb Control Block (VCB) used for all verbs, see Chapter 3,
LUA VCB Structure.
Symbolic constants are defined in the header files /usr/include/sna/lua_c.h and /usr/include/sna/
values_c.h (HP-UX operating system) or sdk/winlua.h (Windows operating system)for many parameter
values. For portability, use the symbolic constant and not the numeric value when setting values for supplied
parameters, or when testing values of returned parameters. The file values_c.h also includes definitions of
parameter types such as AP_UINT16 that are used in the LUA VCBs.
Parameters marked as “reserved” should always be set to 0 (zero).
4.1 RUI_BID
The RUI_BID verb is used by the application to determine when a received message is waiting to be read. This
enables the application to determine what data, if any, is available before issuing the RUI_READ verb.
When a message is available, the RUI_BID verb returns with details of the message flow on which it was received,
the message type, the TH and RH of the message, and up to 12 bytes of message data.
The main difference between RUI_BID and RUI_READ is that RUI_BID enables the application to check the
data without removing it from the incoming message queue, so it can be left and accessed at a later stage. The
RUI_READ verb removes the message from the queue, so once the application has read the data it must process it.
4.1.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_VERB_RECORD).
lua_opcode
LUA_OPCODE_RUI_BID
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
64