op_pk_fd_index_to_name()
摘要
根据指定数据包的格式,将数字字段索引转换为对应的字段名。
语法
op_pk_fd_index_to_name (pkptr, fd_index, fd_name)
| 参数 | 类型 | 说明 |
|---|---|---|
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 |
目标字段的数字索引 [该值应为非负数;但即使为负数也不会出错。] |
fd_name |
char* |
指定字段的名称(由该内核过程填入) [该参数应为静态声明的字符数组,或指向动态分配内存的字符指针;它必须指向一个足够大的字符串,以容纳指定字段的名称。] |
返回类型
void
无返回值。
示例
/* pull the next packet off the queue */
pkptr = op_subq_pk_remove (0, OPC_QPOS_HEAD);
/* determine the number of fields the packet has */
num_fds = op_pk_fd_max_index (pkptr);
/* loop through each field, printing its field name */
for (j = 0; j < num_fds; j++)
{
/* obtain the field name */
op_pk_fd_index_to_name (pkptr, j, fd_name);
/* print the field name */
printf ("Field (%d): Name (%s)\n", j, fd_name);
}
详情
该内核过程仅适用于确定格式化数据包中各字段的名称。不过,将其用于非格式化数据包也不会引起错误,此时字段名字符串会被赋予构造出的值 field_<field_no>。若指定的字段索引大于最后定义的字段,或小于零,也会得到此类值。
目的
为进程提供一种机制:当无法事先知道格式化数据包字段的名称时,可以确定该字段名。这对于需要处理各种不同格式到达数据包的通用进程非常有用。进程可以遍历数据包的各个字段(循环的上界可用内核过程 op_pk_fd_max_index() 确定),通过该内核过程获取每个字段的名称,并根据自身的处理目标,将字段名与一个或多个要查找的名称进行比较。
错误
- 程序中止:段错误。(由于无效的数据包指针、格式错误的数据包,或格式错误的 fd_name 参数)
- 程序中止:数据包指针为 NIL。
- 程序中止:数据包指针指向已被销毁的数据包。
- 可恢复错误:字段索引(
<fd_index>)超出数据包(<pk_id>)的范围。
参考文献
- 使用内核过程 op_pk_nfd_name_to_index() 将字段名转换为数字字段索引
- 使用内核过程 op_pk_fd_max_index() 确定数据包中最高的字段索引
- 使用内核过程 op_pk_nfd_is_set() 根据字段名判断字段是否已设置
- 使用内核过程 op_pk_nfd_type() 根据字段名确定字段的类型
- 使用内核过程 op_pk_nfd_size() 根据字段名确定字段的大小