r6:Function:queue enqueue

From liblfds.org
Jump to: navigation, search

Source Files

/src/queue/queue_queue.c
/inc/liblfds.h

Prototype

int queue_enqueue( struct queue_state *qs, void *user_data );

Parameters

struct queue_state *qs

A queue state as allocated by queue_new.

void *user_data

A void pointer of user data which will be queued into the queue.

Return Value

Returns 1 on a successful enqueue. Returns 0 if enqueing failed. Enqueuing only fails if the queue has exhausted its supply of freelist elements. In this case, the user can call queue_guaranteed_enqueue, which will allocate a new element and enqueue using that. Remember however that the queue can never shrink, so any such call will permanently increase the size of the queue by one element.

Notes

No notes.

See Also