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