oms_buffer_create()
摘要
在指定的池中创建一个新的缓冲区。
语法
oms_buffer_create (buffer_pool, max_units, max_elements, insert_proc, buffer_stats, buffer_name, user_data_ptr, status_ptr, elements_factor_proc)
| 参数 | 类型 | 说明 |
|---|---|---|
buffer_pool |
OmsT_Buffer_Pool_Handle |
执行该操作所在的缓冲区池 |
max_units |
double |
该缓冲区可容纳的最大单元数 |
max_elements |
double |
该缓冲区可容纳的最大元素数 |
insert_proc |
OmsT_Buffer_Insertion_Criteria_Proc |
每当有新元素加入缓冲区时被调用的函数 |
buffer_stats |
OmsT_Buffer_Stats * |
统计量句柄数组 |
buffer_name |
const char * |
与缓冲区关联的名称,用于 ODB 跟踪记录 |
user_data_ptr |
void * |
与缓冲区关联的任意用户数据 |
status_ptr |
OmsT_Buffer_Create * |
指示该新缓冲区创建的成功或失败(及原因) |
elements_factor_proc |
OmsT_Buffer_Elements_Factor_Proc |
用于确定一个元素内部包含多少元素的可选函数(未指定时为 OPC_NIL) |
返回类型
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 数组来指定。每个条目指明该统计量是否要维护以及对应的 stat 句柄。对 buffer_stats 指定 OPC_NIL 表示最初不维护任何统计量。有关这些统计量的更多详细信息,请参见维护的统计量。
可以与缓冲区关联一个可选的名称。这仅在 ODB 中跟踪该缓冲区上的操作时才有用。使用 OPC_NIL 表示不提供名称。
可以与缓冲区关联任意结构。oms_buffer 包不会以任何方式使用该结构,但你的代码可以按需使用它。
如果 status_ptr 不是 OPC_NIL,将填充一个适当的值以描述该操作的结果。关于可能的创建返回值的更多详细信息,请参见缓冲区与池的创建。
elements_factor_proc 是一个可选参数,指定用于确定一个元素由多少元素组成的回调。在缓冲区中插入或出队一个元素时会调用它。如果未指定该回调(参数值为 OPC_NIL),则对于在缓冲区中入队或出队的任何元素,num_elements 将被设置为 1。该回调的原型为:
int
(*OmsT_Buffer_Elements_Factor_Proc) (void* element);