commandQueue.h

/* Copyright (c) 2005-2014, Stefan Eilemann <eile@equalizergraphics.com>
 *
 * This file is part of Collage <https://github.com/Eyescale/Collage>
 *
 * 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/types.h>
#include <lunchbox/thread.h>
#include <limits.h>

namespace co
{
namespace detail { class CommandQueue; }

class CommandQueue : public boost::noncopyable
{
public:
    CO_API explicit CommandQueue( const size_t maxSize = ULONG_MAX );

    CO_API virtual ~CommandQueue();

    CO_API virtual void push( const ICommand& command );

    CO_API virtual void pushFront( const ICommand& command );

    CO_API virtual ICommand pop( const uint32_t timeout =
                                 LB_TIMEOUT_INDEFINITE );

    CO_API virtual ICommands popAll( const uint32_t timeout =
                                     LB_TIMEOUT_INDEFINITE );

    CO_API virtual ICommand tryPop();

    CO_API bool isEmpty() const;

    CO_API void flush();

    CO_API size_t getSize() const;

    virtual void pump() {};

    LB_TS_VAR( _thread );

private:
    detail::CommandQueue* const _impl;
};
}

#endif //CO_COMMANDQUEUE_H