op_pk_nfd_strip()
摘要
从指定数据包中移除一个字段;目标字段通过名称指定。
语法
op_pk_nfd_strip (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* |
目标字段名称 [该名称必须是数据包格式中已定义的字段,否则会发生错误。] |
返回类型
Compcode
完成代码,指示指定字段是否成功变为“未赋值”状态。若发生可恢复错误,将返回常量 OPC_COMPCODE_FAILURE。
示例
/* obtain an arriving packet */
pkptr = op_pk_get (0);
/* obtain the source node of the packet from an integer field */
op_pk_nfd_get (pkptr, "fd_source", &src_node);
/* write the source node out as a statistic */
op_stat_write (0, (double) src_node);
/* strip off the source node field */
op_pk_nfd_strip (pkptr, "fd_source");
/* send the modified packet out */
op_pk_send (pkptr, 0);
详情
该内核过程支持剥离全部五种类型的数据包字段:整数、双精度、数据包、信息和结构。简单数据包字段(即整数、双精度和信息字段)会被该内核过程改为未设置状态,其对数据包总大小的贡献也会被减去。数据包中的数据包字段和结构字段同样会被该内核过程改为未设置状态,其对总数据包大小的贡献也会被减去。但是,这些字段内容所指向的数据包和数据结构会被释放,以严格贯彻被剥离字段内部的封装概念。
数据包字段可以封装本身也带有数据包字段的数据包;这种递归的任意层数均由 op_pk_fd_strip() 支持。封装在结构字段内的数据结构的释放,使用内核过程 op_pk_fd_set() 或 op_pk_nfd_set() 的 dealloc_proc 参数所指定的释放过程来完成。
用途
提供了一种从数据包中移除字段、从而将其对数据包总大小的贡献减去的机制。这通常在以下条件下很有用:
- 数据包正被路由经过一系列处理器或队列。
- 数据包的某些字段用于向中间处理器或队列传递信息。
- 条件 (2) 中的字段不会被数据包路由路径上的任何其他过程访问。
在这些条件下,相关字段可以由中间处理器剥离出去。该内核过程只应应用于已格式化的数据包;否则会发生错误。
错误
- 程序中止:段违例。(由于无效的数据包指针或
fd_name参数) - 程序中止:数据包指针为 NIL。
- 程序中止:数据包指针指向已被销毁的数据包。
- 程序中止:数据包指针指向无主数据包 (<pk_id>)。
- 可恢复错误:数据包 (<pk_id>) 中不存在名为 (<fd_name>) 的字段。
参考
- 使用内核过程
op_pk_fd_strip()从数据包中剥离字段,通过数字索引指定字段 - 使用内核过程
op_pk_nfd_set()的某种形式为数据包字段赋值 - 使用内核过程
op_pk_nfd_get()访问数据包字段的值 - 使用内核过程
op_pk_destroy()释放数据包