RUI_BID谓词通知请求单元接口(RUI)应用程序,消息正等待使用RUI_READ读取。
以下结构描述了RUI_BID使用的谓词控制块(VCB)的LUA_COMMON成员:
第二个语法联合描述了RUI_BID使用的谓词控制块(VCB)的LUA_SPECIFIC成员。 为清楚起见,省略其他工会成员:
语法
struct LUA_COMMON {
unsigned short lua_verb;
unsigned short lua_verb_length;
unsigned short lua_prim_rc;
unsigned long lua_sec_rc;
unsigned short lua_opcode;
unsigned long lua_correlator;
unsigned char lua_luname[8];
unsigned short lua_extension_list_offset;
unsigned short lua_cobol_offset;
unsigned long lua_sid;
unsigned short lua_max_length;
unsigned short lua_data_length;
char FAR * lua_data_ptr;
unsigned long lua_post_handle;
struct LUA_TH lua_th;
struct LUA_RH lua_rh;
struct LUA_FLAG1 lua_flag1;
unsigned char lua_message_type;
struct LUA_FLAG2 lua_flag2;
unsigned char lua_resv56[7];
unsigned char lua_encr_decr_option;
};
union LUA_SPECIFIC {
unsigned char lua_peek_data[12];
};
成员
lua_verb
提供的参数。 包含谓词代码,LUA_VERB_RUI RUI 谓词。
lua_verb_length
提供的参数。 指定逻辑单元应用程序 (LUA) VCB 的长度(以字节为单位)。 它必须包含所发出的谓词记录的长度。
lua_prim_rc
在谓词完成时由 LUA 设置的主要返回代码。 有效的返回代码因颁发的 LUA 谓词而异。
lua_sec_rc
在谓词完成时由 LUA 设置的辅助返回代码。 有效的返回代码因颁发的 LUA 谓词而异。
lua_opcode
提供的参数。 包含要颁发的谓词的 LUA 命令代码(谓词作代码),LUA_OPCODE_RUI_BID。
lua_correlator
提供的参数。 包含一个用户提供的值,该值将谓词与其他用户提供的信息链接在一起。 LUA 不使用或更改此信息。 此参数是可选的。
lua_luname
提供的参数。 指定 Windows LUA 会话使用的本地 LU 的 ASCII 名称。
RUI_BID 仅当 lua_sid 为零时才需要此参数。
如果名称短于 8 个字符,则此参数长度为 8 字节,用空格(0x20)在右侧填充。
lua_extension_list_offset
Microsoft Host Integration Server 中® RUI 未使用,应设置为零。
lua_cobol_offset
主机集成服务器中 LUA 未使用,应为零。
lua_sid
提供的参数。 指定会话标识符,并由 SLI_OPEN 和 RUI_INIT返回。 其他谓词使用此参数标识用于命令的会话。 如果其他谓词使用 lua_luname 参数标识会话,请将 lua_sid 参数设置为零。
lua_max_length
RUI_BID 不使用,应 设置为零。
lua_data_length
返回的参数。 指定在RUI_BID的lua_peek_data中返回的数据长度。
lua_data_ptr
此参数未使用,应设置为零。
lua_post_handle
提供的参数。 在Microsoft Windows Server 下使用(如果事件要完成异步通知)。 此变量包含要发出信号的事件句柄或窗口句柄。
lua_th
返回的参数。 包含收到的消息的 SNA 传输标头(TH)。 为写入函数设置各种子参数,并为读取和投标函数返回。 它的子参数如下所示:
lua_th.flags_fid
格式标识类型 2,4 位。
lua_th.flags_mpf
分段映射字段,两位。 定义数据段的类型。 以下为有效值:
0x00中间段0x04最后一段0x08仅0x0C段
lua_th.flags_odai
发起地址字段 -目标地址字段 (OAF–DAF) 分配器指示器,一位。
lua_th.flags_efi
加速流指示器,一位。
lua_th.daf
目标地址字段 (DAF),一个无符号字符。
lua_th.oaf
发起地址字段 (OAF),一个无符号字符。
lua_th.snf
序列号字段,无符号字符[2]。
lua_rh
返回的参数。 包含已发送或接收的消息的 SNA 请求/响应标头(RH)。 它为写入函数设置,并由读取和投标函数返回。 它的子参数如下所示:
lua_rh.rri
请求-响应指示器,一位。
lua_rh.ruc
RU 类别,两位。 以下为有效值:
LUA_RH_FMD (0x00) FM 数据段LUA_RH_NC (0x20) 网络控制LUA_RH_DFC (0x40) 数据流控制LUA_RH_SC (0x60) 会话控制
lua_rh.fi
格式指示器,一位。
lua_rh.sdi
感知数据包括指示器,一位。
lua_rh.bci
开始链指示器,一位。
lua_rh.eci
结束链指示器,一位。
lua_rh.dr1i
明确响应 1 指示器,一位。
lua_rh.dr2i
明确响应 2 指示器,一位。
lua_rh.ri
异常响应指示器(对于请求),或响应类型指示器(对于响应),一位。
lua_rh.qri
排队响应指示器,一位。
lua_rh.pi
Pacing 指示器,一位。
lua_rh.bbi
开始方括号指示器,一位。
lua_rh.ebi
端括号指示器,一位。
lua_rh.cdi
更改方向指示器,一位。
lua_rh.csi
代码选择指示器,一位。
lua_rh.edi
加密的数据指示器,一位。
lua_rh.pdi
填充的数据指示器,一位。
lua_flag1
提供的参数。 包含包含应用程序提供的消息标志的数据结构。 它的子参数如下所示:
lua_flag1.bid_enable
投标启用指示器,一位。
lua_flag1.close_abend
关闭即时指示器,一位。
lua_flag1.nowait
没有等待数据标志,一位。
lua_flag1.sscp_exp
SSCP 加速流,一位。
lua_flag1.sscp_norm
SSCP 正常流,一位。
lua_flag1.lu_exp
LU 加速流,一位。
lua_flag1.lu_norm
LU 正常流,一位。
lua_message_type
返回的参数。 指定指示 RUI_BID的 SNA 消息的类型。 可能的值为:
LUA_MESSAGE_TYPE_LU_DATA
LUA_MESSAGE_TYPE_SSCP_DATA
LUA_MESSAGE_TYPE_BID
LUA_MESSAGE_TYPE_BIND
LUA_MESSAGE_TYPE_BIS
LUA_MESSAGE_TYPE_CANCEL
LUA_MESSAGE_TYPE_CHASE
LUA_MESSAGE_TYPE_CLEAR
LUA_MESSAGE_TYPE_CRV
LUA_MESSAGE_TYPE_LUSTAT_LU
LUA_MESSAGE_TYPE_LUSTAT_SSCP
LUA_MESSAGE_TYPE_QC
LUA_MESSAGE_TYPE_QEC
LUA_MESSAGE_TYPE_RELQ
LUA_MESSAGE_TYPE_RQR
LUA_MESSAGE_TYPE_RTR
LUA_MESSAGE_TYPE_SBI
LUA_MESSAGE_TYPE_SHUTD
LUA_MESSAGE_TYPE_SIGNAL
LUA_MESSAGE_TYPE_SDT
LUA_MESSAGE_TYPE_STSN
LUA_MESSAGE_TYPE_UNBIND
会话级别接口(SLI)通过 LUA 接口扩展例程接收和响应 BIND、CRV 和 STSN 请求。
LU_DATA、LUSTAT_LU、LUSTAT_SSCP和SSCP_DATA不是 SNA 命令。
lua_flag2
返回的参数。 包含 LUA 返回的消息的标志。 它的子参数如下所示:
lua_flag2.bid_enable
指示如果设置为 1,则已成功重新启用 RUI_BID 。
lua_flag2.async
指示 LUA 接口谓词在设置为 1 时异步完成。
lua_flag2.sscp_exp
指示 SSCP 加速流(如果设置为 1)。
lua_flag2.sscp_norm
如果设置为 1,则指示 SSCP 正常流。
lua_flag2.lu_exp
指示设置为 1 的 LU 加速流。
lua_flag2.lu_norm
如果设置为 1,则指示 LU 正常流。
lua_resv56
保留,应设置为零。
lua_encr_decr_option
保留,应设置为零。
lua_peek_data
RUI_BID和SLI_BID谓词使用的LUA_SPECIFIC的联合成员。 返回的参数。 包含等待读取的数据的最多 12 字节。
返回代码
LUA_OK
主要返回代码;已成功执行谓词。
LUA_CANCELED
主要返回代码;该谓词未成功完成,因为它已被另一个谓词取消。
LUA_TERMINATED
辅助返回代码;此谓词挂起时发出 了RUI_TERM 。
LUA_PARAMETER_CHECK
主要返回代码;由于参数错误,谓词未执行。
LUA_BAD_SESSION_ID
辅助返回代码;VCB 中指定了 lua_sid 的无效值。
LUA_BID_ALREADY_ENABLED
辅助返回代码; RUI_BID 被拒绝,因为以前的 RUI_BID 已经未完成。 一次只能有一个 RUI_BID 未完成。
LUA_INVALID_POST_HANDLE
辅助返回代码;对于使用事件作为异步发布方法的 Windows作系统,Windows LUA VCB 不包含有效的事件句柄。
LUA_RESERVED_FIELD_NOT_ZERO
辅助返回代码;谓词记录中的保留字段或此谓词不使用的参数设置为非零值。
LUA_VERB_LENGTH_INVALID
辅助返回代码;LUA 谓词的值为 LUA 意外 lua_verb_length 发出。
LUA_STATE_CHECK
主要返回代码;该谓词未执行,因为它以无效状态发出。
LUA_NO_RUI_SESSION
辅助返回代码; RUI_INIT 尚未成功完成此谓词中指定的 LU 名称。
LUA_UNSUCCESSFUL
主要返回代码;提供的谓词记录有效,但谓词未成功完成。
LUA_INVALID_PROCESS
辅助返回代码;发出此谓词的过程与为此会话发出 RUI_INIT 的过程不同。 只有启动会话的进程才能在该会话上发出谓词。
LUA_NEGATIVE_RSP
主要返回代码;LUA 检测到从主机接收的数据中出现错误。 LUA 放弃消息(如果消息位于链中),而是将收到的消息传递到 RUI_READ应用程序,而是向主机发送负面响应。
LUA 会通知应用程序后续 RUI_READ 或 RUI_BID 发送了负面响应。
辅助返回代码包含向主机发送的负响应的感知代码。 有关解释可返回的感知代码值的信息,请参阅 使用 LUA 的 SNA 注意事项。
零次返回代码表示,在对链中间的消息做出负面响应之前 RUI_WRITE 之后,LUA 现在已接收并丢弃此链中的所有消息。
LUA_COMM_SUBSYSTEM_ABENDED
主要返回代码;指示以下条件之一:
此会话使用的节点遇到 ABEND。
事务程序(TP)与物理单元(PU)2.1 节点之间的连接已中断(LAN 错误)。
TP 计算机上的 SnaBase 遇到 ABEND。
LUA_SESSION_FAILURE
主要返回代码;所需的 Host Integration Server 组件已终止。LUA_LU_COMPONENT_DISCONNECTED
辅助返回代码;指示由于链接服务或主机 LU 出现问题,LUA 会话失败。
LUA_RUI_LOGIC_ERROR
辅助返回代码;LUA 中检测到内部错误。 在正常作期间不应发生此错误。
LUA_INVALID_VERB
主要返回代码;谓词代码或作代码或两者都无效。 谓词未执行。LUA_STACK_TOO_SMALL
主要返回代码;应用程序的堆栈大小太小,无法执行谓词。 增加应用程序的堆栈大小。LUA_COMM_SUBSYSTEM_NOT_LOADED
主要返回代码;无法在处理谓词时加载或终止所需的组件。 因此,无法进行通信。 请联系系统管理员以采取纠正措施。LUA_UNEXPECTED_DOS_ERROR
主要返回代码;发出作系统调用后,收到意外的作系统返回代码,并在辅助返回代码中指定。
注解
RUI_BID 由要求通知消息等待读取的应用程序使用。 这样,应用程序就可以确定在发出 RUI_READ之前如何处理消息。
当消息可用时, RUI_BID 返回消息流的详细信息、消息类型、消息的 TH 和 RH 以及最多 12 字节的消息数据。
RUI_BID和RUI_READ之间的主要区别在于,RUI_BID允许应用程序检查数据而不将其从传入消息队列中删除,以便以后可以离开和访问数据。 RUI_READ 从队列中删除消息,因此当应用程序读取数据时,它也必须处理它。
使用 RUI_BID时请注意以下事项:
RUI_INIT 必须在发出此谓词之前成功完成。
一次只能有一个 RUI_BID 未完成。
成功完成RUI_BID后,可以通过在后续RUI_READ上设置 lua_flag1.bid_enable 来重新发出它。 如果以这种方式重新发出谓词,则应用程序不得释放或修改与 RUI_BID 记录关联的存储。
如果当 RUI_READ 和 RUI_BID 均未完成时从主机收到消息, 则RUI_READ 完成并 保留RUI_BID 。
到达的每条消息只出价一次。 RUI_BID指示数据正在等待特定会话流后,应用程序会发出RUI_READ来接收数据。 在通过发出RUI_READ接受投标消息之前,任何后续RUI_BID都不会报告到达该会话流的数据。
通常,在此谓词上返回 的lua_data_length 参数仅指示 lua_peek_data中的数据长度,而不是等待消息上的数据总长度(返回值小于 12 时除外)。 应用程序应确保接受数据的 RUI_READ 上的数据长度足以包含消息。