lfQueue.h

/* Copyright (c) 2010-2014, Stefan Eilemann <eile@equalizergraphics.com>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 as published
 * by the Free Software Foundation.
 *
 * This library 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 library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef LUNCHBOX_LFQUEUE_H
#define LUNCHBOX_LFQUEUE_H

#include <lunchbox/atomic.h> // member
#include <lunchbox/debug.h>  // used in inline method
#include <lunchbox/thread.h> // thread-safety checks

#include <vector>

namespace lunchbox
{
template< typename T > class LFQueue : public boost::noncopyable
{
public:
    explicit LFQueue( const int32_t size )
        : _data( size + 1 ), _readPos( 0 ), _writePos( 0 ) {}

    ~LFQueue() {}

    bool isEmpty() const { return _readPos == _writePos; }

    void clear();

    void resize( const int32_t size );

    bool pop( T& result );

    bool getFront( T& result );

    bool push( const T& element );

    size_t getCapacity() const { return _data.size() - 1; }

private:
    std::vector< T > _data;
    a_int32_t _readPos;
    a_int32_t _writePos;

    LB_TS_VAR( _reader );
    LB_TS_VAR( _writer );
};
}

#include "lfQueue.ipp" // template implementation

#endif // LUNCHBOX_LFQUEUE_H