oms_buffer_pool_create()

摘要

创建顶层内存池。

语法

oms_buffer_pool_create (max_units, max_elements, insert_proc, size_proc, destroy_proc, trace_proc, buffer_stats, buffer_pool_name, element_singular_str, elements_plural_str, unit_singular_str, units_plural_str, user_data_ptr, status_ptr)

参数 类型 说明
max_units double 该池可容纳的最大单元数
max_elements double 该池可容纳的最大元素数
insert_proc OmsT_Buffer_Insertion_Criteria_Proc 用于验证新元素能否插入该池的函数
size_proc OmsT_Buffer_Element_Size_Proc 将元素映射为单元数的函数
destroy_proc OmsT_Buffer_Element_Destroy_Proc 销毁元素的函数
trace_proc OmsT_Buffer_Element_Trace_Proc 在 ODB 跟踪记录中显示元素的函数
buffer_stats OmsT_Buffer_Stats * 要维护的统计量句柄数组
buffer_pool_name const char * 该池的名称,用于 ODB 跟踪记录
element_singular_str const char * ODB 跟踪记录中“element”的字符串表示
elements_plural_str const char * ODB 跟踪记录中“elements”的字符串表示
unit_singular_str const char * ODB 跟踪记录中“unit”的字符串表示
units_plural_str const char * ODB 跟踪记录中“units”的字符串表示
user_data_ptr void * 与该池关联的用户数据
status_ptr OmsT_Buffer_Create * 创建操作的结果

返回类型

OmsT_Buffer_Pool_Handle

创建得到的池对象;若创建失败则返回 OPC_NIL。

详细说明

该函数用于创建一个新的内存池,该池可以包含子池或缓冲区。

池的最大容量通过 max_units 和 max_elements 参数加以约束。它们可以是正值(大于 0),也可以是符号常量 OmsC_Buffer_Infinite。

insert_proc 是用于检查后续加入该池的某个缓冲区的任何新元素的函数。它可以是 OPC_NIL(表示不调用任何函数),或者用户指定函数的地址。关于该函数的 API 和用法的详细信息,请参见 oms_buffer_enqueue() 或元素插入。除非某个子池或缓冲区提供了自己的版本,否则默认使用该函数。

由于元素和单元是通用概念,size_proc、destroy_proc 和 trace_proc 为该池提供了正确管理这些概念的手段。size_proc 返回一个元素对应的单元数。destroy_proc 用于销毁存储在缓冲区中的元素。最后,trace_proc 在 ODB 中用于提供元素的字符串表示。原型如下:

double 			Buffer_Element_Size_Proc(void * element);
void 			Buffer_Element_Destroy_Proc(void * element);
const char			Buffer_Element_Trace_Proc(void * element);

每个池都可以自动更新一组统计量。要维护哪些统计量通过传入一个 OmsT_Buffer_Stats 数组来指定。每个条目指明该统计量是否要维护以及对应的 stat 句柄。对 buffer_stats 指定 OPC_NIL 表示最初不维护任何统计量。有关这些统计量的更多详细信息,请参见维护的统计量。

可以与该池关联一个可选的名称。这仅在 ODB 中跟踪该池上的操作时才有用。使用 OPC_NIL 表示不提供名称。

你还可以提供一组字符串,指明在该池的上下文中元素或单元代表什么。一个元素可能代表一个数据包;一个单元可能代表一个字符串。此外,你可以指定这些字符串的单数或复数形式,从而可以报告:

“1 个 <element_singular_string> 已插入”(单数形式)

“该元素长 25 <unit_plural_string>”(复数形式)

可以与该池关联任意结构。oms_buffer 包不会以任何方式使用该结构,但你的代码可以按需使用它。

如果 status_ptr 不是 OPC_NIL,将填充一个适当的值以描述该操作的结果。关于可能的创建返回值的更多详细信息,请参见缓冲区与池的创建。

本站文档由 北京智网畅联科技有限公司 整理、翻译并提供 · 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