private/queue.h

00001 /*
00002  * SpanDSP - a series of DSP components for telephony
00003  *
00004  * private/queue.h - simple in process message queuing
00005  *
00006  * Written by Steve Underwood <steveu@coppice.org>
00007  *
00008  * Copyright (C) 2004 Steve Underwood
00009  *
00010  * All rights reserved.
00011  *
00012  * This program is free software; you can redistribute it and/or modify
00013  * it under the terms of the GNU Lesser General Public License version 2.1,
00014  * as published by the Free Software Foundation.
00015  *
00016  * This program is distributed in the hope that it will be useful,
00017  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00019  * GNU Lesser General Public License for more details.
00020  *
00021  * You should have received a copy of the GNU Lesser General Public
00022  * License along with this program; if not, write to the Free Software
00023  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
00024  *
00025  * $Id: queue.h,v 1.2 2009/01/31 08:48:11 steveu Exp $
00026  */
00027 
00028 #if !defined(_SPANDSP_PRIVATE_QUEUE_H_)
00029 #define _SPANDSP_PRIVATE_QUEUE_H_
00030 
00031 /*!
00032     Queue descriptor. This defines the working state for a single instance of
00033     a byte stream or message oriented queue.
00034 */
00035 struct queue_state_s
00036 {
00037     /*! \brief Flags indicating the mode of the queue. */
00038     int flags;
00039     /*! \brief The length of the data buffer. */
00040     int len;
00041     /*! \brief The buffer input pointer. */
00042     volatile int iptr;
00043     /*! \brief The buffer output pointer. */
00044     volatile int optr;
00045 #if defined(SPANDSP_FULLY_DEFINE_QUEUE_STATE_T)
00046     /*! \brief The data buffer, sized at the time the structure is created. */
00047     uint8_t data[];
00048 #endif
00049 };
00050 
00051 #endif
00052 /*- End of file ------------------------------------------------------------*/

Generated by  doxygen 1.6.2