op_pk_fd_get()
摘要
获取指定数据包中某字段的值;目标字段由数字索引指定。
语法
op_pk_fd_get (pkptr, field_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()。] |
field_index |
int |
目标字段的数字索引 [该值必须为非负数。] |
value_ptr |
void* |
指向一个变量的指针,该变量将被填入指定字段的值 [该参数可以接受指向整数、double、数据包指针或任何其他数据结构指针的指针。参数指针的数据类型必须与指定字段的数据类型匹配。] |
返回类型
Compcode
若字段未获取成功则返回 OPC_COMPCODE_FAILURE,否则返回 OPC_COMPCODE_SUCCESS。
示例
{
/* variable declarations */
int i; double d; Packet *pkptr, *enc_pkptr; struct Custom_DS *ds_ptr;
/* obtain an arriving packet */
pkptr = op_pk_get (0);
/* obtain the simple field types */
op_pk_fd_get (pkptr, 0, &i);
op_pk_fd_get (pkptr, 1, &d);
printf ("packet contents: integer (%d), double (%g)\n", i, d);
/* decapsulate a higher-level packet from the arriving packet */
op_pk_fd_get (pkptr, 2, &enc_pkptr);
op_pk_print (enc_pkptr);
/* extract a data structure from a packet field */
op_pk_fd_get (pkptr, 3, &ds_ptr);
op_pk_destroy (pkptr);
}
详情
该内核过程支持对全部五种数据包字段类型的值访问:integer、double、packet、information 和 structure。但其行为因类型不同而有所差异,如下所述。
integer 和 double 字段
简单数据包字段(integer 和 double)的值会被复制到传入的变量中,除此之外不受该内核过程影响(即这些类型的字段仍保持已设置且可访问的状态,并继续为数据包的总大小贡献相同的比特数)。
packet 和 structure 字段
数据包的 packet 字段和 structure 字段的值(即指向数据包或数据结构的指针)同样会被复制到传入的变量中。
注意: 访问 packet 和 structure 值会产生副作用:这些字段实际上会从数据包中被剥离——其状态变为未设置,其内容对后续的 op_pk_fd_get() 调用不再可访问,并且其对数据包总大小的贡献会被减去。这些副作用旨在强制对被封装字段内容实施严格的所有权规则。访问这些字段的内容在概念上相当于从数据包内部解封装出数据包或数据结构。
information 字段
访问 information 字段的值没有有效用途,因为该字段没有定义的值;但该操作不会导致错误,而是将字符串 “unspecified” 复制到传入的值指针中(传入的地址必须指向一个长度足以容纳该字符串的字符数组)。
用途
提供一种获取数据包字段值的机制。该操作是“将数据包用作进程间通信数据容器”这一目标的基础。通常,当数据包到达处理器或队列的输入流上,并且需要对该数据包进行处理、存储或需要产生响应消息时,会调用该内核过程。
错误
- 程序中止:Segmentation violation.(由于无效的
pkptr或value_ptr参数) - 程序中止:数据包指针为 NIL。
- 程序中止:数据包指针指向已销毁的数据包。
- 程序中止:数据包指针指向无主数据包(
<pk_id>)。 - 可恢复错误:字段索引(
<field_index>)超出数据包(<pk_id>)的范围。
参考
- 使用内核过程 op_pk_fd_set() 的变体,为数据包字段赋值
- 使用内核过程 op_pk_fd_get_dbl(),通过数字索引指定字段,从数据包获取 double 字段的值
- 使用内核过程 op_pk_fd_get_int32(),通过数字索引指定字段,从数据包获取 32 位整数字段的值
- 使用内核过程 op_pk_fd_get_int64(),通过数字索引指定字段,从数据包获取 64 位整数字段的值
- 使用内核过程 op_pk_fd_get_objid(),通过数字索引指定字段,从数据包获取对象 ID 字段的值
- 使用内核过程 op_pk_fd_get_pkt(),通过数字索引指定字段,从数据包获取数据包字段的值
- 使用内核过程 op_pk_fd_get_pkid(),通过数字索引指定字段,从数据包获取数据包 ID 字段的值
- 使用内核过程 op_pk_fd_get_ptr(),通过数字索引指定字段,从数据包获取结构字段的值
- 使用内核过程 op_pk_nfd_get() 的变体,通过名称指定要访问的字段,从格式化数据包获取字段的值
- 使用内核过程 op_pk_fd_type() 确定数据包字段的类型
- 使用内核过程 op_pk_fd_size() 确定数据包字段的大小
- 使用内核过程 op_pk_fd_is_set() 判断数据包字段是否已设置