Traverso/cvs/traverso/src/common/RingBuffer.h

/*
    Copyright (C) 2006 Remon Sijrier
    Ported to C++ for use in Traverso
 
    Copyright (C) 2000 Paul Davis
    Copyright (C) 2003 Rohan Drape
 
    This file is part of Traverso
 
    Traverso is free software; you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
 
    You should have received a copy of the GNU Lesser General Public License
    along with this program; if not, write to the Free Software 
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA.
 
    $Id: RingBuffer.h,v 1.1 2007/10/20 17:38:17 r_sijrier Exp $
*/

#ifndef _RINGBUFFER_H
#define _RINGBUFFER_H


#include <sys/types.h>
#include "defines.h"


typedef struct
{
        char  *buf;
        size_t len;
}
ringbuffer_data_t ;


class RingBuffer
{

public:
        RingBuffer(size_t size);
        ~RingBuffer();

        void get_read_vector(ringbuffer_data_t *vec);

        void get_write_vector(ringbuffer_data_t *vec);

        size_t read(char *dest, size_t cnt);

        size_t peek(char *dest, size_t cnt);

        void read_advance(size_t cnt);

        size_t read_space();

        int mlock_buffer();

        void reset();

        size_t write(const char *src, size_t cnt);

        void write_advance(size_t cnt);

        size_t write_space();

private:
        char                    *buf;
        volatile size_t         write_ptr;
        volatile size_t         read_ptr;
        size_t                  size;
        size_t                  size_mask;
        int                     mlocked;

};

#endif

---