op_pk_fd_max_index()
摘要
返回指定数据包中所有已定义字段的最高整数索引。
语法
op_pk_fd_max_index (pkptr)
| 参数 | 类型 | 说明 |
|---|---|---|
pkptr |
Packet* |
指向目标数据包的指针。 [指向数据包的指针可以从许多内核过程中获得,包括 op_pk_create()、op_pk_create_fmt()、op_pk_copy()、op_pk_get()、op_subq_pk_access() 和 op_subq_pk_remove()。] |
返回类型
int
整数值,为当前数据包中任何已定义字段的最大索引。对于不含任何字段的非格式化数据包,将返回常量 OPC_INT_INVALID。
示例
/* Obtain the newly arrived packet. */
pkptr = op_pk_get (op_intrpt_strm ());
/* Obtain the packet format name and verify that it is known */
op_pk_format (pkptr, format_name);
if (tp_verify_format (format_name) == OPC_FALSE)
{
/* Discard the packet since it is unrecognized. */
op_pk_destroy (pkptr);
}
else
{
/* Fields beyond TP_FD_INDEX_RTE_BASE are a record of the route travelled. */
/* Determine how many hops there are. Include the base itself. */
num_hops = op_pk_fd_max_index (pkptr) - TP_FD_INDEX_RTE_BASE + 1;
/* Loop through the hops and update the local view of the nodes' conditions. */
for (i = 0; i < num_hops; i++)
{
op_pk_fd_get (pkptr, TD_FD_INDEX_RTE_BASE + i, &node_id);
...
详情
对于不含"扩展"字段(即在数据包格式最后一个字段之外设置的字段)的格式化数据包,该内核过程的行为很直观:返回的值比格式所定义的字段数目小 1。无论这些格式化字段是否已设置,都是如此。
对于完全非格式化的数据包,或包含通过内核过程 op_pk_fd_set() 设置的扩展字段的格式化数据包,op_pk_fd_max_index() 返回当前已设置的最高的非格式化字段的索引;曾经设置过但之后已通过内核过程 op_pk_fd_strip() 剥离的字段将不被考虑。
目的
该内核过程返回的值通常用作遍历数据包字段的循环的包含上界。当无法事先了解数据包的结构、必须逐一检查每个字段以判断其是否已设置或其内容是否值得关注时,最常使用该内核过程。
错误
- 程序中止:段错误。(由于无效的数据包指针或格式错误的数据包)
- 程序中止:数据包指针为 NIL。
- 程序中止:数据包指针指向已被销毁的数据包。
参考文献
- 使用内核过程 op_pk_fd_type() 确定字段的类型
- 使用内核过程 op_pk_fd_is_set() 判断字段是否已被赋值
- 使用内核过程 op_pk_fd_index_to_name() 获取数据包格式中所指定的字段名称