op_pk_encap_pk_get()
摘要
从指定的封装数据包中获取被封装数据包的一份副本。
语法
op_pk_encap_pk_get (pkptr, format, encap_pk_pptr)
| 参数 | 类型 | 说明 |
|---|---|---|
pkptr |
Packet* |
指向目标数据包的指针 [指向数据包的指针可以从许多内核过程获得,包括 op_pk_create()、op_pk_create_fmt()、op_pk_copy()、op_pk_get()、op_subq_pk_access() 和 op_subq_pk_remove()。] |
format |
const char |
字符串,包含某个数据包格式的名称,或「详情」一节所述的某个符号常量 |
encap_pk_pptr |
Packet** |
数据包指针的指针 [此处指定的指针将被填入指向一个新创建数据包的指针,该数据包是被封装数据包的副本。] |
返回类型
Compcode
指示解封装是否成功的完成代码。
如果成功,该内核过程返回 OPC_COMPCODE_SUCCESS;否则返回 OPC_COMPCODE_FAILURE。
示例
摘自 models/std/utilities/oms 中的 oms_bgutil.ex.c。
if (op_pk_encap_flag_is_set (pkptr, OMSC_BGUTIL_ENCAP_FLAG_INDEX))
{
/* Drill to get a copy of the actual bgutil packet. */
op_pk_encap_pk_get (pkptr, "bgutil_tracer", &bgutil_pkptr);
if (bgutil_pkptr == OPC_NIL)
{
return_routed_bgutil = 0.0;
*routed_packets_per_sec_ptr = 0.0;
FRET (return_routed_bgutil);
}
/* Get the src and dest objids. */
op_pk_nfd_get (bgutil_pkptr, "src_objid", &src_objid);
op_pk_nfd_get (bgutil_pkptr, "dest_objid", &dest_objid);
...
}
详情
该函数在指定数据包中搜索其中封装的、具有给定格式的其他数据包。它将 encap_pk_pptr 填入指向一个新数据包的指针,该数据包是被封装数据包的副本。与任何其他数据包一样,该数据包稍后必须被销毁,以避免内存错误。
该函数获取具有指定格式的第一个被封装数据包。除格式名称外,format 还可以是下表所述的某个常量。
| 如果常量为… | 该函数获取的第一个… |
|---|---|
NONE |
无格式或值向量数据包 |
OPC_PK_FORMAT_ANY |
数据包(不论格式) |
OPC_PK_FORMAT_ANY_FORMATTED |
有格式的数据包 |
OPC_PK_FORMAT_ANY_UNFORMATTED |
无格式的数据包 |
OPC_PK_FORMAT_ANY_VVEC |
值向量数据包 |
如果封装数据包内部没有指定格式的数据包,该函数返回 OPC_FAILURE。
如果获取到的数据包是 SAR 分段,该函数会在该分段的源数据包中递归查找指定格式的数据包。
用途
提供一种快速获取被封装数据包副本的机制。
错误
- 程序中止:Segmentation violation.(由于无效的数据包指针或格式错误的数据包)
参考
- 使用内核过程 op_pk_encap_pk_access() 获取被封装数据包的引用
- 使用内核过程 op_pk_encap_flag_set() 在待封装的数据包上置标志
- 使用内核过程 op_pk_encap_flag_is_set() 检查被封装数据包上是否已置标志
- 使用内核过程 op_pk_format() 获取数据包格式的名称