oms_buffer_subpool_create()
摘要
在指定池内创建一个新的子池。
语法
oms_buffer_subpool_create (buffer_pool, max_units, max_elements, insert_proc, pool_stats, pool_name, user_data_ptr, status_ptr)
| 参数 | 类型 | 说明 |
|---|---|---|
buffer_pool |
OmsT_Buffer_Pool_Handle |
执行该操作的缓冲区池 |
max_units |
double |
该子池可容纳的最大单元数 |
max_elements |
double |
该子池可容纳的最大元素数 |
insert_proc |
OmsT_Buffer_Insertion_Criteria_Proc |
每当有新元素加入该子池的某个缓冲区时调用的函数 |
pool_stats |
OmsT_Buffer_Stats * |
统计量句柄数组 |
pool_name |
const char * |
为该子池关联的名称,用于 ODB 跟踪 |
user_data_ptr |
void * |
与该子池关联的任意用户数据 |
status_ptr |
OmsT_Buffer_Create * |
指示该新子池创建成功或失败(及原因)的标志 |
返回类型
OmsT_Buffer_Handle
创建的池对象;若操作失败则为 OPC_NIL。
详细说明
缓冲区的最大容量通过 max_units 和 max_elements 参数加以限制。这些值可以是正数(大于 0),也可以是符号常量 OmsC_Buffer_Infinite 或 OmsC_Buffer_Parent_Limit 之一。如果指定后者,该子池将使用其父池的限制。否则,指定的值将表示该子池自身的限制。子池的限制必须与其父池的限制一样严格或更严格,否则创建操作将失败。
insert_proc 是用于检查后续加入该子池的某个缓冲区的任何新元素的函数。它可以是 OPC_NIL(表示不调用任何函数)、oms_buffer_pool_criteria_proc(表示使用为父池指定的那个函数),或者用户指定函数的地址。关于该函数的 API 和用法的详细信息,请参见 oms_buffer_enqueue() 或元素插入。
每个子池都可以自动更新一组统计量。要维护的统计量列表通过传入一个 OmsT_Buffer_Stats 数组来指定。每个条目指明该统计量是否要维护以及对应的统计量句柄。对 pool_stats 指定 OPC_NIL 表示最初不维护任何统计量。有关这些统计量的更多详细信息,请参见维护的统计量。
可以为该子池关联一个可选名称。这仅在 ODB 中跟踪该子池的操作时有用。使用 OPC_NIL 表示未提供名称。
可以为该子池关联任意结构。oms_buffer 包不会以任何方式使用该结构,但你的代码可以按需使用它。
如果 status_ptr 不是 OPC_NIL,将填充一个适当的值以描述该操作的结果。关于可能的创建返回值的更多详细信息,请参见缓冲区与池的创建。