op_pk_nfd_set()
已弃用——请使用显式指定类型的 op_pk_nfd_set_<type>()
摘要
为指定数据包中的整型、双精度或数据包字段赋值;目标字段通过名称指定。
注意:该形式仅用于整型、双精度和数据包字段。对于其他字段类型,请使用其他形式(详情参见目的部分)。
语法
op_pk_nfd_set (pkptr, fd_name, value)
| 参数 | 类型 | 说明 |
|---|---|---|
pkptr |
Packet* |
指向目标数据包的指针 [数据包的指针可以从许多内核过程获得,包括 op_pk_create_fmt()、op_pk_copy()、op_pk_get()、op_subq_pk_access() 和 op_subq_pk_remove()。] |
fd_name |
char* |
目标字段的名称 [该名称必须是数据包格式中已定义的字段,否则会发生错误。] |
value |
void* |
要赋给该字段的值 [该值可以是整型、双精度或数据包指针。] |
返回类型
Compcode
完成代码,指示是否为指定字段成功赋了新值。如果发生可恢复错误,将返回常量 OPC_COMPCODE_FAILURE。
示例
/* create a formatted packet */
f_pkptr = op_pk_create_fmt ("example_pkt");
/* assign integer fields in the packet */
op_pk_nfd_set (f_pkptr, "fd_int_1", 2511);
int_value = 5 * 200;
op_pk_nfd_set (f_pkptr, "fd_int_2", int_value);
/* assign double fields in the packet */
op_pk_nfd_set (f_pkptr, "fd_double_1", 3.1415);
db_value = 33.5 / 27.1;
op_pk_nfd_set (f_pkptr, "fd_double_2", db_value);
/* encapsulate a higher-level packet in the packet */
enc_pkptr = op_pk_create (24);
op_pk_nfd_set (f_pkptr, "fd_packet", enc_pkptr);
/* send the defined packet out of the processor */
op_pk_send (f_pkptr, OUTSTRM);
详情
value 参数可以接受整型、双精度或数据包指针值。该内核过程内部的逻辑会根据数据包的内部格式判断传入参数的类型,并相应地调整其字段赋值方式。如果指定字段此前未被设置过,新字段的大小也将由数据包格式确定,并累加到数据包的总大小中。
对于整型、双精度和数据包字段类型,需要指定字段的值。被赋给字段的数据包会被“封装”(encapsulated)在该内核过程所操作的数据包内部,调用该内核过程的进程将失去对被封装数据包的所有权。这些被封装的数据包在被 op_pk_fd_get()(若数据包是格式化的,也可选择 op_pk_nfd_get())解封装之前是不可访问的。
类型为数据包的字段采用一种特殊技术来动态确定大小。当使用数据包格式编辑器(Packet Format Editor)在数据包格式中定义这类字段时,字段大小在数据表的某一列中指定。如果指定的字段大小设置为“inherited”(继承),该字段的大小将跟随被封装数据包的大小,从而准确地模拟聚合数据包大小。如果表中为此类字段指定的大小为零或正数,则会覆盖任何被封装数据包的大小,从而支持数据压缩的建模。
目的
提供一种设置数据包内部字段值的机制。由于数据包是格式化的,只需指定字段的值;字段的类型和大小(若使用未格式化版本的内核过程 op_pk_fd_set() 则需要指定)会自动从格式中获取。
**注意:**该内核过程只应应用于格式化数据包;否则会发生错误。
op_pk_nfd_set() 的该形式支持整型、双精度和数据包字段类型。该内核过程的其他形式支持信息字段类型(op_pk_nfd_set())和结构字段类型(op_pk_nfd_set())。
该内核过程存在针对特定数据类型的版本。这些替代内核过程比这种可变参数版本更高效;此外,它们还能让编译器捕获该内核过程遗漏的参数错误。详情参见 op_pk_nfd_set_int32()、op_pk_nfd_set_int64()、op_pk_nfd_set_dbl()、op_pk_nfd_set_objid()、op_pk_nfd_set_pkid() 和 op_pk_nfd_set_pkt()。
错误
- 程序中止:段违例。(由无效的数据包指针或 fd_name 参数引起)
- 程序中止:数据包指针为 NIL。
- 程序中止:数据包指针指向已被销毁的数据包。
- 程序中止:数据包指针指向无主数据包 (
<pk_id>)。 - 可恢复错误:数据包 (
<pk_id>) 中没有名为 (<fd_name>) 的字段。
参考
- 使用该内核过程的其他形式为数据包的信息字段或结构字段赋值
- 使用内核过程 op_pk_fd_set() 的变体,通过数字索引指定字段,为数据包中的字段赋值
- 使用内核过程 op_pk_nfd_get() 的变体,获取数据包中字段的值
- 使用内核过程 op_pk_nfd_strip() 取消数据包中某字段的设置,并从数据包总大小中减去其贡献