|
|
| Line 1: |
Line 1: |
| ==Source Files== | | ==Source Files== |
| /src/ringbuffer/ringbuffer_query.c | | /src/slist/slist_delete.c |
| /inc/liblfds.h | | /inc/liblfds.h |
|
| |
| ==Enums==
| |
| enum ringbuffer_query_type
| |
| {
| |
| RINGBUFFER_QUERY_VALIDATE
| |
| };
| |
|
| |
|
| ==Prototype== | | ==Prototype== |
| void ringbuffer_query( struct ringbuffer_state *rs, enum ringbuffer_query_type query_type, void *query_input, void *query_output ); | | void slist_delete( struct slist_state *ss ); |
|
| |
|
| ==Parameters== | | ==Parameters== |
| ''struct ringbuffer_state *rs'' | | ''struct slist_state *ss'' |
| : A ringbuffer state as allocated by ''[[r6:Function:ringbuffer_new|ringbuffer_new]]''. | | : An slist state as allocated by ''[[r6:Function:slist_new|slist_new]]''. |
| | |
| ''enum ringbuffer_query_type query_type''
| |
| : Indicates which query to perform.
| |
| | |
| ''void *query_input''
| |
| : A pointer to data, or data cast to a void pointer, which is input data required by requested query. Only some queries require input data. If no input data is required, set query_input to NULL.
| |
| | |
| ''void *query_output''
| |
| : The address of a variable into which the requested information is placed. The type of variable varies on the type of query; see Notes.
| |
|
| |
|
| ==Return Value== | | ==Return Value== |
| No return value. The variable pointed to by ''query_output'' (the type of which will vary depending on the query, see Notes) will be set; this is the mechanism by which information is passed back to the caller. Currently, no query can fail, so there is no notion of an error value. | | No return value. |
|
| |
|
| ==Notes== | | ==Notes== |
| The following query is currently supported;
| | This function deletes the slist. The ''user_data_delete_function'' function provided to ''slist_new'' is called with the user data from each element. |
| | |
| * RINGBUFFER_QUERY_VALIDITY
| |
| ** ''query_input'' may be NULL or may point to a ''struct validation_info''. This structure contains the minimum and maximum expected number of elements currently held in the ringbuffer (set minimum and maximum to the same value if the exact value is known). The expected minimum and maximum number of elements in the queue, the queue's freelist and the ringbuffer's freelist can all be derived from the original numbers, since the queue begins empty and the initial number of elements in the freelist is known. If NULL, no check for missing or additional elements is performed.
| |
| ** ''query_output'' must point to an an array of three ''enum data_structure_validity''. The validation check detects loops, missing elements and additional elements in the queue, the queue's freelist and the ringbuffer's freelist and sets the values of query_output accordingly. The first element in the array is used for the queue's validity state, the second for the queue's freelist's validity state, the third for the ringbuffer's freelist's validity state The main purpose of this query is to provide a validation function to the test program.
| |
|
| |
|
| ==See Also== | | ==See Also== |
| * [[r6:API:Ringbuffer|Ringbuffer]] | | * [[r6:API:SList|SList]] |
| | * [[r6:Function:slist_new|slist_new]] |