function lfds711_stack_cleanup

Source Files

└───liblfds711
    ├───inc
    │   └───liblfds711
    │           lfds711_stack.h
    └───src
        └───lfds711_stack
                lfds711_stack_cleanup.c

Opaque Structures

struct lfds711_stack_element;
struct lfds711_stack_state;

Prototype

void lfds711_stack_cleanup( struct lfds711_stack_state *ss,
                            void (*element_cleanup_callback)(struct lfds711_stack_state *ss, struct lfds711_stack_element *se) );

Parameters

struct lfds711_stack_state *ss

A pointer to an initialized struct lfds711_stack_state.

void (*element_cleanup_callback)(struct lfds711_stack_state *ss, struct lfds711_stack_element *se)

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

Notes

The cleanup function actually does no work except, if the callback function is provided, to make all pushed stack elements valid for the current logical core and to iterate over the stack and pass each element to the callback function.

The user can in the callback function use the LFDS711_STACK_GET_USER_STATE_FROM_STATE macro on the stack state to get hold of the user state provided when the stack was initialized.

See Also

• Stack
• lfds711_stack_init_valid_on_current_logical_core