op_subq_pk_remove()

摘要

获取存储在指定子队列中指定位置的数据包的指针,并将该数据包从子队列中移除。

语法

op_subq_pk_remove (subq_index, pos_index)
参数 类型 说明
subq_index int 目标子队列的数字索引 [子队列流索引从 0 开始,依次递增 1。子队列的数量没有上限,但如果连续使用它们,可以实现内存的节约使用。除了显式的子队列索引,还可以指定抽象子队列选择索引。抽象子队列选择索引通过某个子队列独有的属性来指定该子队列。可接受的抽象子队列选择索引列于表 85“Subqueue Selection Index Symbolic Constants“ 第 26 页。]
pos_index int 要移除的数据包在子队列内所处的数字位置索引 [位置索引从队列头部处的 0 开始,依次递增 1 直到尾部。除了显式的位置索引,还可以指定抽象子队列位置索引(参见表 84“Subqueue Position Index Symbolic Constants“ 第 25 页);可接受的取值为 OPC_QPOS_HEAD、OPC_QPOS_TAIL 和 OPC_QPOS_PRIO。]

返回类型

Packet*

指向从指定子队列中移除的数据包的指针。若发生可恢复错误,将返回常量 OPC_NIL。

示例

摘自:示例模型(models/std/base);进程模型(pf_fifo);状态(SEND_HEAD);enter execs。

/* a request has been made to forward a packet */
/* over one of the queue’s output streams      */
/* the packet will be pulled from the subqueue */
/* with the same index as the output stream    */

/* determine which subqueue is being accessed */
subq_index = op_intrpt_code ();

/* check if it is empty */
if (op_subq_empty (subq_index) == OPC_FALSE)
	{
	/* access the first packet in the subqueue */
	pkptr = op_subq_pk_remove (subq_index, OPC_QPOS_HEAD);

	/* forward it to the destination over requested stream */
	/* use ’quiet’ mode to avoid causing a stream interrupt. */
	op_pk_send_quiet (pkptr, subq_index);
	}

详情

本 KP 只能在与队列模块上运行的进程的上下文中调用(或由队列进程直接或间接调用的函数中调用);从处理器上运行的进程或管道级调用它将导致错误。

子队列初始时为空。数据包通过 KP op_subq_pk_insert() 加入子队列,并通过 KP op_subq_pk_remove()、op_subq_flush() 或 op_q_flush() 从中移除。

如果指定的位置索引为负值(且不是受支持的符号常量之一),或大于或等于队列中数据包的数量,将发生可恢复错误并返回常量 OPC_NIL。

用途

提供一种从子队列移除数据包的机制。这是数据包以非破坏方式离开子队列的唯一方式(即仿真内核没有让数据包自动流出子队列的机制)。数据包离开子队列的唯一其他途径是通过破坏性 KP op_subq_flush() 和 op_q_flush()。即使是所提供的基干排队模型,也显式地使用本 KP 从子队列中提取数据包。位置索引参数为决定应移除哪个数据包提供了灵活性;它可以是一个具体的数字位置(包括方便指定的头部或尾部位置),也可以是由数据包优先级决定的位置(此时无论占据哪个位置,被移除的都是优先级最高的数据包)。

错误

  • 程序中止:KP 需要队列上下文。
  • 可恢复错误:子队列选择标志(<flag>)无法识别。
  • 可恢复错误:位置(<pos_index>)超出子队列(<subq_index>)的范围。

参考

本站文档由 北京智网畅联科技有限公司 整理、翻译并提供 · Documentation compiled and provided by Beijing ZNetLink Technology Co., Ltd.

交流群 · QQ Group:OPNET/智网妙算网络仿真交流群(群号 486383494)

原文档 © 2017 Riverbed Technology · 本站为公益翻译,由 AI 辅助完成,请仔细甄别

Original documentation © 2017 Riverbed Technology. Community translation, AI-assisted. Contact: jiazequn@znetlink.com