op_pk_fd_access_read_only_ptr()
摘要
只读访问指定数据包中存储的结构;目标字段由数字索引指定。
语法
op_pk_fd_access_read_only_ptr (pkptr, fd_index, 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_index |
int |
目标字段的数字索引(必须 >= 0) |
value_ptr |
const void** |
指向一个变量的指针,该变量将被填入所访问的结构。该变量本身必须是指向某个数据结构的指针。 |
返回类型
Compcode
若字段未获取成功则返回 OPC_COMPCODE_FAILURE,否则返回 OPC_COMPCODE_SUCCESS。
示例
/* Access the datagram field information structure */
/* to check destination address. */
op_pk_fd_access_read_only_ptr (pk_copy_ptr, pk_fd_index, (void**)&pkt_fields_ptr);
if (pkt_fields_ptr->dest_== my_addr)
. . . ;
详情
若成功,*value_ptr 将被设置为数据包中存储的结构的地址。该结构不会从数据包中被移除(op_pk_fd_get_ptr() 则会在访问时将其移除),并且共享(如果存在)也不会被禁用。
注意: 该内核过程只应用于访问结构型数据包字段。访问其他类型的字段将导致错误。对于数值型字段,请使用某一类型化的 op_pk_fd_get… 内核过程。
用途
提供一种高效只读访问存储在数据包内部结构的机制。仅当客户端不会以任何方式修改结构内容时才可使用该内核过程。
具有数据包广播功能的模型(如无线和总线模型)通常会对每个广播数据包进行克隆,使每个接收者都获得原始数据包的一份自己的副本。但为了仿真效率,仿真内核会共享实际的数据包内容,并将克隆推迟到调用了可能修改数据包内容的内核过程之时。该内核过程允许访问结构而不触发数据包的克隆。
当接收端的客户端希望检查结构内容以判断是否满足某些条件(例如目的地址),进而丢弃数据包(如果它并非发往接收该数据包的节点)或将其沿协议栈上传时,该内核过程特别有用。在这种情况下使用 op_pk_fd_access_read_only_ptr() 可确保不会因为访问字段的结构而复制数据包内容——否则若结构内容并不满足条件,复制出的内容马上就会被丢弃。
错误
- 程序中止:Segmentation violation.(由于无效的
pkptr或value_ptr参数) - 程序中止:数据包指针为 NIL。
- 程序中止:数据包指针指向已销毁的数据包。
- 程序中止:数据包指针指向无主数据包(
<pk_id>)。 - 可恢复错误:数据包(
<pk_id>)的字段(<field_index>)类型为(<field_type>)。 - 可恢复错误:字段索引(
<field_index>)超出数据包(<pk_id>)的范围。 - 可恢复错误:数据包(
<pk_id>)中不存在索引为(<field_index>)的字段。 - 可恢复错误:数据包(
<pk_id>)的内容是值向量。数据包不允许字段操作。
参考
- 使用内核过程 op_pk_fd_get_ptr(),通过数字索引指定字段,从数据包获取结构字段的值
- 使用内核过程 op_pk_fd_access_ptr(),从数据包获取结构字段的值而不将结构从数据包中移除
- 使用内核过程 op_pk_nfd_get() 的变体,通过名称指定要访问的字段,从格式化数据包获取字段的值
- 使用内核过程 op_pk_fd_set() 的变体,为数据包字段赋值
- 使用内核过程 op_pk_fd_type() 确定数据包字段的类型
- 使用内核过程 op_pk_fd_size() 确定数据包字段的大小
- 使用内核过程 op_pk_fd_is_set() 判断数据包字段是否已设置