function lfds710_queue_umm_query

From liblfds.org
Jump to: navigation, search

Source Files

└───liblfds710
    ├───inc
    │   └───liblfds710
    │           lfds710_queue_umm.h
    └───src
        └───lfds710_queue
                lfds710_queue_umm_query.c

Enums

enum lfds710_queue_umm_query
{
  LFDS710_QUEUE_UMM_QUERY_SINGLETHREADED_GET_COUNT,
  LFDS710_QUEUE_UMM_QUERY_SINGLETHREADED_VALIDATE
};

Opaque Structures

struct lfds710_queue_umm_state;

Prototype

void lfds710_queue_umm_query( struct lfds710_queue_umm_state *qumms,
                              enum lfds710_queue_umm_query query_type,
                              void *query_input,
                              void *query_output );

Parameters

struct lfds710_queue_umm_state *qumms

A pointer to an initialized struct lfds710_queue_umm_state.

enum lfds710_queue_umm_query 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 query indicated by query_type.

void *query_output

A pointer to store into which the requested information is placed, where the output data varies by the query indicted by query_type.

Queries

void *query_input

A pointer to input data for the query, where the data varies by query;
LFDS710_QUEUE_UMM_QUERY_SINGLETHREADED_GET_COUNT
query_input is NULL.
LFDS710_QUEUE_UMM_QUERY_SINGLETHREADED_VALIDATE
query_input can be NULL, or or can be a pointer to a struct lfds710_misc_validation_info, which specifies an expected min/max count, in which case validation also counts the number of elements and check they fall within the specified range.

void *query_output

A pointer to output store for the query, where the output varies by query;
LFDS710_QUEUE_UMM_QUERY_SINGLETHREADED_GET_COUNT
Points to a lfds710_pal_uint_t, which is set to the number of elements in the queue.
LFDS710_QUEUE_UMM_QUERY_SINGLETHREADED_VALIDATE
Points to an enum lfds710_misc_validity, which is set to indicate the result of the validation operation.

Notes

All SINGLETHREADED queries can only be safely performed if no enqueue or dequeue operations occur while the operation runs. If enqueue or dequeue operations do occur during the execution of a SINGLETHREADED query, it is theoretically possible for the query to enter an infinite loop. Do not do this.

See Also