---

epQueue.h File Reference

#include "epList.h"

Include dependency graph for epQueue.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
epQueue_t*	epQueue_create (int (*elementDeallocatorFunction)(void *elt))
int	epQueue_destroy (epQueue_t *queue)
int	epQueue_in (epQueue_t *queue, const void *elt)
void*	epQueue_out (epQueue_t *queue)
int	epQueue_size (epQueue_t *queue)
boolean_t	epQueue_isEmpty (epQueue_t *queue)
int	epQueue_setElementPrintFunction ( epQueue_t *queue, char *(*elementPrintFunction)(void *elt))
int	epQueue_printIt (epQueue_t *queue, char *title)

---

Detailed Description

Author(s):

Guillaume Bour. U.B.O 2000/2001

Version:

0.1.0

Date:

28/12/2000

Date:

25/11/2001 added title parameter to epQueu_printIt() function.

Common queue. Header file

Definition in file epQueue.h.

---

Define Documentation

#define _EPQUEUE_H_

Definition at line 15 of file epQueue.h.

#define _QUEUE_DIR   _FIFO

Definition at line 20 of file epQueue.h.

#define epQueue_t   epList_t

Definition at line 19 of file epQueue.h.

---

Function Documentation

epQueue_t * epQueue_create ( int(* elementDeallocatorFunction)(void *elt) )

Create & initialize a new queue. visibility :: public Remarks: If no element deallocator function is passed in argument (i.e. NULL), then the default pointer deallocator function is applied. Parameters: elementDeallocatorFunction   the function used to deallocate an element Returns: the created queue (a pointer) or NULL if an error occurs Definition at line 37 of file epQueue.c.

int epQueue_destroy ( epQueue_t * queue )

Destroy the queue and all the elements contained into. visibility :: public Parameters: queue   the considered queue Return values: 0   if OK, -1   else Definition at line 55 of file epQueue.c.

int epQueue_in ( epQueue_t * queue, const void * elt )

Insert a new element back of the queue. visibility :: public Parameters: queue   the considered queue elt   the to-insert element Return values: 0   if OK, -1   else Definition at line 74 of file epQueue.c.

boolean_t epQueue_isEmpty ( epQueue_t * queue )

Return <true> if the queue is empty, <false> else. visibility :: public Parameters: queue   the considered queue Return values: <true>   if the queue is empty, <false>   if not Definition at line 128 of file epQueue.c.

void * epQueue_out ( epQueue_t * queue )

Return and remove-from the element on top of the queue. visibility :: public Parameters: queue   the considered queue Returns: the on-the-top element, or NULL if the queue is empty Definition at line 92 of file epQueue.c.

int epQueue_printIt ( epQueue_t * queue, char * title )

Print the content of the queue (its parameters and all its elements). visibility :: public Warning: 1. some memory leaks may be encountered Parameters: list   the considered list title   a title to print ahead Return values: 0   if OK, -1   else. Definition at line 172 of file epQueue.c.

int epQueue_setElementPrintFunction ( epQueue_t * queue, char *(* elementPrintFunction)(void *elt) )

Initialize the elementPrintFunction for the use of the printIt function. visibility :: public Parameters: queue   the considered queue elementPrintFunction   the function to use @reval 0 if OK, Return values: -1   else. Definition at line 148 of file epQueue.c.

int epQueue_size ( epQueue_t * queue )

Return the size of the queue (the number of its elements). visibility :: public Parameters: queue   the considered queue Returns: the size of the queue Definition at line 110 of file epQueue.c.

---