oms_buffer_pool_flush()
Abstract
Iterates through the elements in the pool’s buffers and removes every element for which the flush procedure returns true.
Syntax
oms_buffer_pool_flush (buffer_pool_handle, flush_proc, user_data_ptr)
| Argument | Type | Description |
|---|---|---|
buffer_pool_handle |
OmsT_Buffer_Pool_Handle |
buffer pool object to flush |
flush_proc |
OmsT_Buffer_Element_Flush_Proc |
function used to determine which elements to flush from the pool |
user_data_ptr |
void * |
user data passed to flush_proc |
Return Type
None.
Details
This function iterates through the elements in each buffer in the pool (and its subpool). For each element, the specified flush_proc is invoked with the element, the element insertion time in the buffer, and user_data_ptr. If flush_proc returns OPC_TRUE, the element is removed from the buffer and destroyed using the procedure specified in the root pool creation. See oms_buffer_pool_create().
The flush procedure has the following prototype:
Boolean OmsT_Buffer_Element_Flush_Proc
void *element,
double insertion_time,
void *user_data_ptr);