op_pk_nfd_is_set()
摘要
判断指定数据包中的某个字段是否已设置;目标字段通过名称指定。
语法
op_pk_nfd_is_set (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_FALSE,表示该不存在的字段未被设置。] |
返回类型
Boolean
布尔值,指示指定字段当前是否有赋值。
若指定字段已设置,该值为 OPC_TRUE;若字段未设置或发生错误,则为 OPC_FALSE。
示例
节选自:示例模型(models/std/tcp_ip);进程模型(session_mux);状态(TO_APPL)的 enter execs。
/* send this last packet also */
if (op_pk_nfd_is_set (pkptr, "app data");
{
/* get the encapsulated packet */
op_pk_nfd_get (pkptr, "app data", &appl_interface_pkt);
/* get its size */
data_size = op_pk_total_size_get (appl_interface_pkt) / 8;
/* ... */
}
详情
数据包字段以列表形式存储在数据包内部。它们始终以数字索引标识,而在格式化数据包中它们还带有相应的字段名称。通过内核过程 op_pk_create() 创建的未格式化数据包最初没有任何已定义的字段(其字段列表为空)。通过内核过程 op_pk_create_fmt() 创建的格式化数据包最初具有关联数据包格式中的全部已定义字段;其中一些字段可能在创建时即被自动设置(即具有默认值)。
如果使用内核过程 op_pk_fd_strip() 或 op_pk_nfd_strip() 从数据包中剥离一个已设置的字段,被剥离的字段将变为未设置状态。若将内核过程 op_pk_nfd_is_set() 应用于被剥离的字段或从未设置过的字段,将返回 OPC_FALSE。
目的
提供一种判断数据包字段是否已设置的机制。这可以在尝试获取字段值之前先对字段进行测试,从而避免字段未设置时发生错误。如果数据包格式的定义较为灵活,某些字段可能根据数据包进入周围模块之前的历史而被设置或未被设置,此时就可能出现这种情况。该内核过程只应应用于格式化数据包;将其应用于未格式化数据包时,无论传入什么字段名称字符串,结果都将始终返回 OPC_FALSE(但不会发生错误)。
错误
- 程序中止:段违例。(由无效的数据包指针或 fd_name 参数引起)
- 程序中止:数据包指针为 NIL。
- 程序中止:数据包指针指向已被销毁的数据包。
- 可恢复错误:数据包 (
<pk_id>) 中没有名为 (<fd_name>) 的字段。
参考
- 使用内核过程 op_pk_fd_is_set() 判断未格式化(或格式化)数据包中的字段是否已设置,通过数字索引指定目标字段
- 使用内核过程 op_pk_nfd_size() 确定数据包字段的大小
- 使用内核过程 op_pk_nfd_type() 确定数据包字段的类型
- 使用内核过程 op_pk_fd_max_index() 确定数据包中最高的字段索引