op_subq_flush()
摘要
清空指定的子队列,并销毁其中包含的任何数据包。
语法
op_subq_flush (subq_index)
| 参数 | 类型 | 说明 |
|---|---|---|
subq_index |
int |
目标子队列的数字索引 [子队列流索引从 0 开始,依次递增 1。子队列的数量没有上限,但如果连续使用它们,可以实现内存的节约使用。除了显式的子队列索引,还可以指定抽象子队列选择索引。抽象子队列选择索引通过某个子队列独有的属性来指定该子队列。可接受的抽象子队列选择索引列于表 85“Subqueue Selection Index Symbolic Constants“ 第 26 页。] |
返回类型
void
无返回值。
示例
subq_index = get_subq_index_from_connection (cur_connection_ptr);
if (connection_aborted_flag)
{
/* This connection is terminated. */
if (op_subq_empty (subq_index) == OPC_FALSE)
{
/* Subqueue contains messages queued for processing. */
/* Flush the subqueue of messages. */
op_subq_flush (subq_index);
}
}
详情
本 KP 只能在与队列模块上运行的进程的上下文中调用(或由队列进程直接或间接调用的函数中调用);从处理器上运行的进程或管道级调用它们将导致错误。
子队列初始时为空。数据包通过 KP op_subq_pk_insert() 加入子队列,并通过 KP op_subq_pk_remove()、op_subq_flush() 或 op_q_flush() 从中移除。
用途
提供一种移除子队列中所有数据包的机制。数据包在此过程中被销毁,因此该操作仅用于因某种动态条件可以丢弃子队列中数据包的场合。需要清空子队列的典型建模应用包括:节点崩溃或重启、链路或链路接口宕机、使当前缓冲数据失效的路由或其他网络管理更新,以及关闭无需投递当前缓冲消息的虚电路或会话。
错误
- 程序中止:KP 需要队列上下文。
- 可恢复错误:子队列选择标志(
<flag>)无法识别。 - 程序中止:段违例。(由于队列中存在格式错误的数据包,或入队数据包中存在格式错误的结构或数据包字段所致)
参考
- 使用 KP op_q_flush() 清空外围队列中的所有子队列
- 使用 KP op_subq_empty() 判断子队列中是否没有数据包
- 使用 KP op_subq_stat(),以
OPC_QSTAT_PKSIZE符号常量作为参数,判断子队列中包含的数据包数量 - 使用 KP op_subq_pk_remove() 从子队列移除单个数据包,并获取其指针