co/commandQueue.h

/* Copyright (c) 2005-2011, 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 CO_COMMANDQUEUE_H
#define CO_COMMANDQUEUE_H

#include <co/api.h>
#include <co/base/lock.h>
#include <co/base/mtQueue.h>
#include <co/base/nonCopyable.h>
#include <co/base/thread.h>

namespace co
{
    class Command;

    class CommandQueue : public base::NonCopyable
    {
    public:
        CO_API CommandQueue();
        CO_API virtual ~CommandQueue();

        CO_API virtual void push( Command& packet );

        CO_API virtual void pushFront( Command& packet );

        virtual void wakeup() { _commands.push( static_cast< Command* >( 0 )); }

        CO_API virtual Command* pop( const uint32_t timeout =
                                     EQ_TIMEOUT_INDEFINITE );

        CO_API virtual Command* tryPop();

        bool isEmpty() const { return _commands.isEmpty(); }

        CO_API void flush();

        size_t getSize() const { return _commands.getSize(); }

        EQ_TS_VAR( _thread );

    private:
        base::MTQueue< Command* >  _commands;
    };
}

#endif //CO_COMMANDQUEUE_H