queue.h

Go to the documentation of this file.

/*
 *       _____
 * ANSI / ___/
 *     / /__  
 *     \___/  
 *
 * Filename: queue.h
 * Author  : Kyle Loudon/Dan Levin
 * Date    : Fri Mar 22 12:40:45 GMT 2013
 * Version : 0.51
 * ---
 * Description: A C interface for a generic queue ADT.
 * 
 * Revision history - coming up below:
 *
 * Date        Revision message
 * 2012-12-20  Created this file
 * 2013-02-19  Made some revision to the Doxygen documentation. Enhanced the description of
 *             in/out parameters - i.e. double-pointers.             
 * 2015-03-31  This code ready for ver. 0.51
 *
 */

#ifndef _QUEUE_H_
#define _QUEUE_H_

#include <stdio.h>
#include <stdlib.h>

#include "slist.h"

#ifdef __cplusplus
extern "C" {
#endif

  typedef Slist Queue;

  /* INTERFACE FUNCTION DECLARATIONS */

  Queue QUEUEinit(void (*destroy)(void *data));

  void QUEUEdestroy(Queue queue);

  int QUEUEenqueue(Queue queue, const void *data);

  int QUEUEdequeue(Queue queue, void **data);

  void *QUEUEpeek(Queue queue);

  int QUEUEisempty(Queue queue);

  int QUEUEsize(Queue queue);

#ifdef __cplusplus
}
#endif 

#endif /* _QUEUE_H_ */