queue.h 1.78 KB
/**
 * \file
 * Holds requests ready for processing.
 * 
 * \todo change this to a real queue.
 *
 * \author	Georg Hopp
 *
 * \copyright
 * Copyright © 2014 Georg Hopp
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef __TR_QUEUE_H__
#define __TR_QUEUE_H__

#include <pthread.h>
#include <sys/types.h>

#include "trbase.h"


TR_CLASS(TR_Queue) {
	void *    msg;
	TR_Queue  next;

	pthread_mutex_t lock;

	/**
	 * first and last are only available in the initial queue
	 * element (the root). This elelment does not contain any message
	 * and exists only for organizational purpose.
	 *
	 * \todo next and first always have to be the same...so get rid
	 * of first.
	 */
	TR_Queue  first;
	TR_Queue  last;
	size_t    nmsg;
	int       free_msgs;
};
TR_INSTANCE_INIT(TR_Queue);
TR_CLASSVARS_DECL(TR_Queue) {};

void       TR_queuePut(TR_Queue, void *);
void       TR_queuePutFirst(TR_Queue, void *);
void     * TR_queueGet(TR_Queue);
TR_Queue   TR_queueFind(TR_Queue, void *);
TR_Queue   TR_queueFindParent(TR_Queue, void *);
void       TR_queueDelete(TR_Queue, void *);
void       TR_queueDestroy(TR_Queue);

#define TR_queueEmpty(this)		(0 >= (this)->nmsg)

#endif // __TR_QUEUE_H__

// vim: set ts=4 sw=4: