worker.h

/* Copyright (c) 2011-2014, Stefan Eilemann <eile@eyescale.ch>
 *
 * 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_WORKER_H
#define CO_WORKER_H

#include <co/api.h>          // CO_API definition
#include <co/types.h>
#include <lunchbox/thread.h>  // base class
#include <limits.h>

#ifdef COLLAGE_SHARED
#  define CO_WORKER_API CO_API
#else
#  define CO_WORKER_API
#endif

namespace co
{
template< class Q > class WorkerThread : public lunchbox::Thread
{
public:
    explicit WorkerThread( const size_t maxSize = ULONG_MAX )
        : _commands( maxSize ) {}

    virtual ~WorkerThread() {}

    Q* getWorkerQueue() { return &_commands; }

protected:
    CO_WORKER_API void run() override;

    virtual bool stopRunning() { return false; }

    virtual bool notifyIdle() { return false; }

private:
    Q _commands;
};

typedef WorkerThread< CommandQueue > Worker; // instantiated in worker.cpp
}
#endif //CO_WORKER_H