op_pk_fd_is_set()
摘要
判断指定数据包中的某个字段是否已设置;目标字段由数字索引指定。
语法
op_pk_fd_is_set (pkptr, fd_index)
| 参数 | 类型 | 说明 |
|---|---|---|
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 |
目标字段的数字索引 [该值应为非负数;但即使为负数也不会出错,此时将返回 OPC_FALSE,表示指定字段未设置。] |
返回类型
Boolean
布尔值,指示指定字段当前是否已有赋值。
若字段在数据包中已定义且已设置,返回值为 OPC_TRUE;否则返回 OPC_FALSE。
示例
/* obtain an arriving packet */
pkptr = op_pk_get (1);
/* determine the number of defined fields the packet has */
num_fds = op_pk_fd_max_index (pkptr);
/* determine the number of set fields the packet has */
/* (loop through each field, incrementing a count variable if the field is set) */
for (j = 0, num_set = 0; j < num_fds; j++)
if (op_pk_fd_is_set (pkptr, j))
num_set++;
详情
数据包字段以列表形式存储在数据包内部。它们始终按数字索引编号;在格式化数据包中,字段还额外带有对应的字段名。通过内核过程 op_pk_create() 创建的非格式化数据包在创建时没有任何已定义的字段(其字段列表为空)。通过内核过程 op_pk_create_fmt() 创建的格式化数据包则定义了关联数据包格式中的全部字段;其中一些字段可能在创建时即被自动设置(即它们具有默认值)。
若某个已设置的字段通过内核过程 op_pk_fd_strip() 或 op_pk_nfd_strip() 从数据包中被剥离,该被剥离的字段将变为未设置状态。若将内核过程 op_pk_fd_is_set() 应用于已被剥离的字段或从未设置过的字段,将返回 OPC_FALSE。
目的
提供一种判断数据包字段是否已设置的机制。可在尝试获取字段值之前先测试该字段,从而避免字段未设置时发生错误。若数据包格式的定义较为灵活——某些字段是否已设置取决于数据包进入外围模块之前的历史——就可能出现这种情况。该内核过程通常用于非格式化数据包,但也可用于格式化数据包(格式化数据包的字段名可用内核过程 op_pk_nfd_name_to_index() 转换为数字索引)。
错误
- 程序中止:段错误。(由于无效的数据包指针或格式错误的数据包)
- 程序中止:数据包指针为 NIL。
- 程序中止:数据包指针指向已被销毁的数据包。
参考文献
- 使用内核过程 op_pk_nfd_is_set() 判断格式化数据包中的字段是否已设置,用名称指定目标字段
- 使用内核过程 op_pk_fd_size() 确定数据包字段的大小
- 使用内核过程 op_pk_fd_type() 确定数据包字段的类型
- 使用内核过程 op_pk_fd_max_index() 确定数据包中的最大字段索引