function lfds711_queue_bmm_cleanup

From liblfds.org
Jump to navigation Jump to search

Source Files

└───liblfds711
    ├───inc
    │   └───liblfds711
    │           lfds711_queue_bmm.h
    └───src
        └───lfds711_queue
                lfds711_queue_bmm_cleanup.c

Opaque Structures

struct lfds711_queue_bmm_state;

Prototype

void lfds711_queue_bmm_cleanup( struct lfds711_queue_bmm_state *qbmms,
                                void (*element_cleanup_callback)(struct lfds711_queue_bmm_state *qbmms,
                                                                 void *key,
                                                                 void *value) );

Parameters

struct lfds711_queue_bmm_state *qbmms

A pointer to an initialized struct lfds711_queue_bmm_state.

void (*element_cleanup_callback)(struct lfds711_queue_bmm_state *qbmms, void *key, void *value)

A callback function which is called with the key and value of every element present in the queue at the time of cleanup. This argument can be NULL.

Notes

This function cleans up an initialized queue. If element_cleanup_callback is not NULL, it is called once for each element in the queue.

See Also