r6:Function:freelist new elements

From liblfds.org
Jump to: navigation, search

Source Files

/src/freelist/freelist_new.c
/inc/liblfds.h

Prototype

atom_t freelist_new_elements( struct freelist_state *fs, atom_t number_elements );

Parameters

struct freelist_state *fs

A freelist state as allocated by freelist_new.

atom_t number_elements

The number of additional elements to add to the freelist.

Return Value

The number of elements added to the freelist.

Notes

This function creates a new freelist element and adds it to the freelist, repeating this process number_elements times. Each element will be passed to the user_data_init_function function passed into the freelist_new function. That function will also be passed the user_state argument which was provided to freelist_new. If element creation fails (will can be only due to memory allocation failure or failure of the user initialisation function), that element will not be created and so the number of elements actually added to the freelist will be less than the requested number.

This function is thread-safe; it can be used in parallel with other functions adding new elements and with pushing and popping.

See Also