op_pk_nfd_access_read_only_ptr()
摘要
以只读方式访问存储在指定数据包中的结构;目标字段由名称指定。
语法
op_pk_nfd_access_read_only_ptr (pkptr, fd_name, value_ptr)
| 参数 | 类型 | 说明 |
|---|---|---|
pkptr |
Packet* |
目标数据包的指针 [许多内核过程都可以获得数据包指针,包括 op_pk_create()、op_pk_create_fmt()、op_pk_copy()、op_pk_get()、op_subq_pk_access() 和 op_subq_pk_remove()。] |
fd_name |
const char* |
目标字段的名称 [该名称必须是数据包格式中已定义的字段。] |
value_ptr |
const void** |
指向某个变量的指针,用于填入所访问的结构。该变量本身必须是指向某个数据结构的指针。 |
返回类型
Compcode
如果未能获取该字段,返回 OPC_COMPCODE_FAILURE;否则返回 OPC_COMPCODE_SUCCESS。
示例
/* Access the datagram field information structure */
/* to check destination address. */
op_pk_nfd_access_read_only_ptr (pk_copy_ptr, “fields”, (void**)&pkt_fields_ptr);
if (pkt_fields_ptr->dest_== my_addr)
. . . ;
详情
如果成功,*value_ptr 将被设置为存储在数据包中的结构的地址。该结构不会从数据包中被移除(与 op_pk_nfd_get_ptr() 不同),共享关系(如果存在)也不会被禁用。
注意: 该内核过程只应用于访问结构类型的数据包字段。访问其他类型的字段将导致错误。对于数值字段,请使用某个带类型的 op_pk_nfd_get… 内核过程。
用途
提供对存储在数据包内部的结构进行高效只读访问的机制。只有在客户端不会以任何方式修改结构内容时才能使用该内核过程。
采用数据包广播的模型(如无线和总线模型)通常会对每个广播数据包进行克隆,使每个接收者都获得原始数据包属于自己的副本。然而为了仿真效率,仿真内核会共享实际的数据包内容,并将克隆推迟到可能修改数据包内容的内核过程被调用之时。该内核过程允许访问结构而不触发数据包的克隆。
当接收端的客户端希望检查结构的内容,以判断是否满足某些条件(例如目的地址),并据此丢弃数据包(如果它并非发给接收该数据包的节点)或将其传递给上层协议栈时,该内核过程特别有用。在这种情况下使用 op_pk_nfd_access_read_only_ptr() 可以确保不会因为访问字段的结构而复制数据包内容——否则一旦结构内容不满足条件,这些副本又会被立即丢弃。
错误
- 程序中止:段错误。(由于
pkptr或value_ptr参数无效) - 程序中止:数据包指针为 NIL。
- 程序中止:数据包指针指向已被销毁的数据包。
- 程序中止:数据包指针指向不属于自己的数据包(
<pk_id>)。 - 可恢复错误:数据包(
<pk_id>)的字段(<field_name>)的类型为(<field_type>);无法将其值设置为 void *。 - 可恢复错误:结构字段的返回地址为 NIL。
参考
- 使用内核过程
op_pk_nfd_get_ptr()从数据包中获取结构字段的值,通过名称指定字段 - 使用内核过程
op_pk_nfd_access()获取整数、double、结构或信息字段的值,并保持字段不变 - 使用内核过程
op_pk_nfd_get()的某个变体从格式化数据包中获取字段的值,通过名称指定要访问的字段 - 使用内核过程
op_pk_nfd_set()的某个变体为数据包字段赋值,通过名称指定要访问的字段 - 使用内核过程
op_pk_nfd_type()确定数据包字段的类型 - 使用内核过程
op_pk_nfd_size()确定数据包字段的大小 - 使用内核过程
op_pk_nfd_is_set()判断数据包字段是否已置位