oms_buffer_pool_free_units_get()
Abstract
Returns the number of elements that could be added to the pool.
Syntax
oms_buffer_pool_free_units_get (buffer_pool_handle)
| Argument | Type | Description |
|---|---|---|
buffer_pool_handle |
OmsT_Buffer_Pool_Handle |
buffer pool object to query |
Return Type
double
Number of elements that could be added to the pool.
Details
This function returns the number of elements that could be added to the pool based on its maximum size. A value of OmsC_Buffer_Infinite is returned if the pool has infinite capacity.
Note that the actual number of elements that can be added is also constrained by the parent pool and what is stored in other buffers in these pools. Therefore, the value returned by this function is really an upper bound.