op_pk_fd_set()
摘要
为指定数据包中的 information 字段指定类型和大小;目标字段由数字索引指定。
注意: 该 KP 格式仅用于 information 字段。其他字段类型请使用替代格式(详见用途一节)。
语法
op_pk_fd_set (pkptr, fd_index, type, size)
| 参数 | 类型 | 说明 |
|---|---|---|
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 |
目标字段的数字索引 [该值必须为非负数,否则会发生错误。] |
type |
int |
要分配给字段的类型 [这是一个指定字段类型的数字代码(参见表 55 “Field Type Symbolic Constants“ 第 14 页);该 KP 格式唯一可接受的值为 OPC_FIELD_TYPE_INFO。] |
size |
int、double 或 OpT_Int64 |
字段内容的大小(以比特计),或 OPC_FIELD_SIZE_UNCHANGED [如果该参数的类型为 double 或 OpT_Int64,必须对 type 参数进行增强。更多信息见详情一节。] |
返回类型
Compcode
如果字段能够被设置,返回 OPC_COMPCODE_SUCCESS;否则返回 OPC_COMPCODE_FAILURE。
示例
/* create an unformatted packet */
uf_pkptr = op_pk_create (0);
/* assign an integer code to the packet */
op_pk_fd_set (uf_pkptr, FD_TYPE, OPC_FIELD_TYPE_INTEGER, DATA_XFER, 16);
/* assign an information field to the packet */
op_pk_fd_set (uf_pkptr, FD_DATA, OPC_FIELD_TYPE_INFO, 1500);
/* send the defined packet out of the processor */
op_pk_send (uf_pkptr, OUTSTRM);
详情
对于 information 字段类型,只需指定字段的 size,因为该字段所建模数据的实际值与仿真无关。通过内核过程 op_pk_fd_get() 获取 information 字段的值并没有有效用途,但它不会导致错误,而是将字符串“unspecified”复制到传入的值指针中。如果指定的字段大小与其先前的大小不同,数据包的总大小将按比例变化。
如果 size 的类型为 double,必须通过添加 OR 运算符 (|) 和标志 OPC_FIELD_SIZE_IS_DOUBLE 来增强 type 参数;否则底层代码会将 size 参数解释为整数值。如果 size 参数的类型为 OpT_Int64,必须通过添加 OR 运算符 (|) 和 OPC_FIELD_SIZE_IS_INT64 标志来增强 type 参数。例如,
op_pk_fd_set (pkptr, 0, OPC_FIELD_TYPE_INFO, 16) |
使用类型为 integer 的 size 参数(将值 16 作为整数(四字节)参数) |
op_pk_fd_set (pkptr, 0,OPC_FIELD_TYPE_INFO|OPC_FIELD_SIZE_IS_DOUBLE, 16.0) |
使用类型为 double 的 size 参数(将值 16.0 作为 double(八字节)参数) |
OpT_Int64 the_size = 16;op_pk_fd_set (pkptr, 0,OPC_FIELD_TYPE_INFO|OPC_FIELD_SIZE_IS_INT64,the_size) |
使用类型为 64 位整数的 size 参数(将值 16 作为 64 位整数(八字节)参数) |
如果 size 与字段的先前大小不同,数据包的总大小将相应变化。如果 size 为 OPC_FIELD_SIZE_UNCHANGED,字段的大小将保持数据包中原有的定义。
注意: OPC_FIELD_SIZE_UNCHANGED 是一个 64 位值。使用它时,必须为 OpT_Int64 参数增强 type 参数,如下所示:
op_pk_fd_set (pkptr, field_index,
OPC_FIELD_TYPE_INFO|OPC_FIELD_SIZE_IS_INT64,
OPC_FIELD_SIZE_UNCHANGED)
用途
提供一种设置数据包中 information 字段值的机制。该内核过程通常用于非格式化数据包,但也可以用于有格式数据包(有格式数据包的字段名称可以使用内核过程 op_pk_name_to_index() 和 op_pk_nfd_name_to_index() 转换为数字索引)。
op_pk_fd_set() 的该格式仅支持 information 字段类型,因为未指定字段值。该内核过程的替代格式支持 integer、double 或 packet 字段类型(op_pk_fd_set())和 structure 字段类型(op_pk_fd_set())。
该内核过程存在按数据类型区分的版本。该替代内核过程比该可变参数版本更高效。此外,它使编译器能够捕获该内核过程遗漏的参数错误。详情参见 op_pk_fd_set_info()。
错误
- 程序中止:段错误。(由于无效的数据包指针或格式错误的数据包)
- 程序中止:数据包指针为 NIL。
- 程序中止:数据包指针指向已被销毁的数据包。
- 程序中止:数据包指针指向无主的数据包 (
<pk_id>)。 - 程序中止:内存分配失败。
- 可恢复错误:字段类型 (
<type>) 无法识别。 - 可恢复错误:字段大小 (
<size>) 超出范围。 - 可恢复错误:字段索引 (
<fd_index>) 对数据包 (<pk_id>) 而言超出范围。
参考
- 使用该内核过程的替代格式为数据包的 integer、double、packet 或 structure 字段赋值
- 使用内核过程 op_pk_nfd_set() 的变体之一,通过名称指定字段,为有格式数据包中的字段赋值。
- 使用内核过程 op_pk_fd_strip() 的变体之一,取消设置数据包中的字段,并从数据包总大小中减去其贡献