op_pk_nfd_default()
摘要
获取指定格式化数据包中某字段的默认值;目标字段通过名称指定。
语法
op_pk_nfd_default (pkptr, fd_name)
| 参数 | 类型 | 说明 |
|---|---|---|
pkptr |
Packet* |
指向目标数据包的指针 [数据包的指针可以从许多内核过程获得,包括 op_pk_create_fmt()、op_pk_copy()、op_pk_get()、op_subq_pk_access() 和 op_subq_pk_remove()。] |
fd_name |
const char* |
目标字段的名称 [该名称应当是数据包格式中已定义的字段;但即使不是,也不会发生错误,而是返回常量值 OPC_DBL_UNDEF。] |
返回类型
double
指定字段的默认值。
[在数据包格式中,只有整型(integer)和双精度(double)字段可以赋予有意义的默认值。该内核过程对整型和双精度默认值均返回 double;如有需要,可将返回值强制转换为整型。如果发生错误,返回 OPC_DBL_UNDEF。]
示例
/* obtain an arriving packet */
pkptr = op_pk_get (0);
/* determine the default value of the opcode field */
def_opcode = (int) op_pk_nfd_default (pkptr, "opcode");
/* restore the default value to the opcode field */
op_pk_nfd_set (pkptr, "opcode", def_opcode);
详情
数据包格式编辑器允许在指定字段类型之前先指定字段的默认值,因此任何类型的字段都可以被赋予默认值。但是,默认值只对整型和双精度字段有效。
如果将该内核过程应用于未格式化的数据包,或发生任何可恢复错误,将返回常量 OPC_DBL_UNDEF。
目的
提供一种机制,用于确定格式化数据包中某字段的默认值。当进程需要将字段重置为默认值、但事先不知道默认值是什么时,这一机制非常有用。
错误
- 程序中止:段违例。(由无效的数据包指针或格式错误的数据包引起)
- 程序中止:数据包指针为 NIL。
- 程序中止:数据包指针指向已被销毁的数据包。
- 程序中止:数据包指针指向无主数据包 (<pk_id>)。
- 可恢复错误:数据包 (<pk_id>) 中不存在名为 (<fd_name>) 的字段。
参考
- 使用内核过程 op_pk_nfd_get() 获取数据包字段的当前值
- 使用内核过程 op_pk_nfd_type() 确定数据包字段的类型
- 使用内核过程 op_pk_nfd_size() 确定数据包字段的大小