function lfds700_queue_bss_cleanup

Source Files

└───liblfds700
    ├───inc
    │   └───liblfds700
    │           lfds700_queue_bounded_singleconsumer_singleproducer.h
    └───src
        └───lfds700_queue_bounded_singleconsumer_singleproducer
                lfds700_queue_bounded_singleconsumer_singleproducer_cleanup.c

Opaque Structures

struct lfds700_queue_bss_state;

Prototype

void lfds700_queue_bss_cleanup( struct lfds700_queue_bss_state *qbsss, void (*element_cleanup_callback)(struct lfds700_queue_bss_state *qbsss, void *key, void *value) );

Parameters

struct lfds700_queue_bss_state *qbsss

A pointer to an initialized struct lfds700_queue_bss_state.

void (*element_cleanup_callback)(struct lfds700_queue_bss_state *qbsss, void *key, void *value)

A callback function which is called with 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.

After lfds700_queue_bss_cleanup is complete, the user is safe to deallocate the store used for the queue state.

Example

Coming soon. No, really! (Written 29th Dec 2015).

See Also

• Queue (bounded, single consumer, single producer)
• lfds700_queue_bss_init_valid_on_current_logical_core