r6.0.0:lfds600_ringbuffer_delete

From liblfds.org
Jump to: navigation, search

Source Files

/liblfds600/src/lfds600_ringbuffer/lfds600_ringbuffer_delete.c
/liblfds600/inc/liblfds600.h

Prototype

void lfds600_ringbuffer_delete( struct lfds600_ringbuffer_state *rs,
                              void (*user_data_delete_function)(void *user_data, void *user_state),
                              void *user_state );

Parameters

struct lfds600_ringbuffer_state *rs

A ringbuffer state as allocated by lfds600_ringbuffer_new.

void (*user_data_delete_function)(void *user_data, void *user_state)

A callback function, which can be NULL. This function is called with the user data void pointer from each element before that element is deleted, giving the user an opportunity to delete any allocated state.

void *user_state

This pointer is passed into the user_data_delete_function as its second argument, enabling the caller to pass state into the callback function.

Return Value

No return value.

Notes

This function deletes the ringbuffer. The user data void pointer in each element will be passed to user_data_delete_function prior to deletion, permitting the caller to release any per-element state.

See Also