op_ima_obj_svar_get()
摘要
获取指定对象(进程或队列)内部某个状态变量的指针。
语法
op_ima_obj_svar_get (objid, svar_name)
| 参数 | 类型 | 说明 |
|---|---|---|
objid |
Objid |
目标对象的对象 ID [进程或队列的对象 ID 可以从 Topo 和 Id 包中的多个 KP 获得: op_topo_assoc()、op_topo_child()、op_id_self() 和 op_id_from_name()。] |
svar_name |
const char* |
目标状态变量的名称 [该值必须是指定进程或队列的进程模型中已定义的状态变量的名称,否则会发生错误。注意,此值中不应包含反斜杠字符(进程编辑器状态变量块中用于界定状态变量名称的字符)。] |
返回类型
void*
指向指定状态变量的指针。发生可恢复错误时将返回 OPC_NIL。由于状态变量可以具有任何数据类型,本 KP 返回的值声明为 void*(指向可变数据类型的指针)。要通过返回的指针访问状态变量,应将其转换为适当数据类型的指针。
示例
/* determine the object ID of a remote queue */
rem_node_objid = op_id_from_name (0, OPC_OBJTYPE_NODE_FIXED, "frnt_end");
rem_queue_objid = op_id_from_name (rem_node_objid, OPC_OBJTYPE_QUEUE, "qbs");
/* obtain key state variables of queueing process */
prio_thresh_ptr = (int *) op_ima_obj_svar_get (rem_queue_objid, "prio_thresh");
protocol_version = (char *) op_ima_obj_svar_get (rem_queue_objid, "proto_ver");
/* modify the state variables */
*prio_thresh_ptr = 44;
sprintf (protocol_version, "Ver 5.1");
详情
本 KP 只能成功地应用于队列和进程对象,因为只有这些对象运行的进程具有可供用户访问的状态变量。将其应用于其他对象类型会导致错误。
进程或队列除了根进程之外还可以包含子进程。根进程的状态变量就是 op_ima_obj_svar_get() 所获取的变量。子进程的状态变量可以使用 op_pro_svar_get() 获取。
尽管本 KP 是 MT 安全的(如“Multi-Threading Safety“第 11 页中所述),但如果多个客户端正在访问或修改共享的 svar 信息,则必须谨慎使用。
用途
提供了一种进程间通信的替代机制(除数据包、ICI、远程中断、统计量线、全局变量,以及使用 KP op_ima_obj_attr_set() 远程设置属性之外)。通过访问另一个进程的状态变量,进程可以通过信号量进行通信、监视执行状态,或修改远程进程的运行方式。远程状态变量的编程范式类似于内存映射总线接口计算机外设上共享寄存器的概念。
错误
- 程序中止:段违例。(由于格式错误的 svar_name 参数)
- 可恢复错误:对象 ID(
<objid>)超出范围。 - 可恢复错误:对象(
<objid>)类型不正确。应为队列或进程对象。 - 可恢复错误:状态变量(
<svar_name>)未在根进程模型中定义。 - 可恢复错误:对象 ID(
<objid>)指向受限对象。
参考
- 使用 KP op_pk_deliver() 可将数据包投递到远程模块
- 使用 KP op_intrpt_schedule_remote() 可中断远程模块
- 使用 KP op_stat_write() 可向连接到另一模块的统计量线写入值
- 使用 KP op_ima_obj_attr_set()、op_ima_obj_attr_set_dbl()、op_ima_obj_attr_set_int32()、op_ima_obj_attr_set_objid()、op_ima_obj_attr_set_str() 和 op_ima_obj_attr_set_toggle() 可赋值远程模块的某个属性