op_pk_get()
摘要
获取一个已到达输入数据包流的数据包的指针,并将该数据包从流中移除。
语法
op_pk_get (instrm_index)
| 参数 | 类型 | 说明 |
|---|---|---|
instrm_index |
int |
所在模块的某个输入数据包流的索引 |
返回类型
Packet*
指向从输入流中取出的数据包的指针。
如果指定的输入流中没有任何数据包,该内核过程将返回 OPC_NIL;可以先调用内核过程 op_strm_empty() 判断流中是否含有数据包,以避免这种情况。
示例
摘自:示例模型(models/std/base);进程模型(prq_fifo);状态(REQUEUE);enter execs。
/* a packet is being ’pushed’ onto the head of the queue */
pkptr = op_pk_get (op_intrpt_strm ());
/* insert the new packet at head of subqueue 0 */
if (op_subq_pk_insert (0, pkptr, OPC_QPOS_HEAD) != OPC_QINS_OK)
{
/* if the insertion failed, discard the packet */
op_pk_destroy (pkptr);
}
详情
该内核过程可以获取通过数据包流发送的数据包,以及由远程模块投递的数据包。就进入模块而言,采用这两种方式传输的数据包在处理上没有区别。
通过内核过程 op_send_quiet() 或 op_deliver_quiet() 静默发送或投递到输入流的数据包,不会在相关模块处产生中断。如果多个静默数据包到达某个输入流,它们将按到达顺序排队。在这种情况下,op_pk_get() 只获取输入流中排队的多个数据包中的第一个;后续可连续调用该内核过程以获取流中剩余的数据包(输入流中排队的数据包数量可以通过内核过程 op_strm_pksize() 获取)。
该内核过程需要进程上下文,因此只能从进程模型、或由进程模型直接或间接调用的函数中调用。无格式和有格式的数据包都可以通过该内核过程获取。
当以超过现有最高输入流索引的输入流索引调用该内核过程时,仿真内核将尝试分配新的输入流。这一能力支持通过数据包投递机制在数量不受限制的输入流上接收数据包。
用途
提供一种获取已到达所在模块的数据包的机制。该内核过程是进程最初获得其未创建或未声明的数据包的唯一途径;因此绝大多数进程模型都会使用该内核过程。
错误
- 程序中止:内核过程需要进程上下文。
- 程序中止:内存分配失败。
- 可恢复错误:输入流索引 (
<instrm_index>) 超出范围。(由于流索引为负数)
参考
- 使用内核过程 op_pk_send() 通过输出流将数据包发送到另一个模块
- 使用内核过程 op_pk_deliver() 将数据包投递到未连接模块的输入流
- 使用 op_pk_send() 或 op_pk_deliver() 的变体传输延迟到达、强制到达或静默到达的数据包
- 使用内核过程 op_strm_empty() 或 op_strm_pksize() 判断输入流中是否含有数据包