GenericThread.h

//
//  GenericThread.h
//  libraries/shared/src
//
//  Created by Brad Hefta-Gaub on 8/12/13.
//  Copyright 2013 High Fidelity, Inc.
//
//  Generic Threaded or non-threaded processing class.
//
//  Distributed under the Apache License, Version 2.0.
//  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
 
#ifndef hifi_GenericThread_h
#define hifi_GenericThread_h
 
#include <QtCore/QObject>
#include <QMutex>
#include <QThread>
 
class GenericThread : public QObject {
    Q_OBJECT
public:
    GenericThread();
    virtual ~GenericThread();
 
    void initialize(bool isThreaded = true, QThread::Priority priority = QThread::NormalPriority);
 
    void terminate();
 
    virtual void terminating() { }; // lets your subclass know we're terminating, and it should respond appropriately
 
    bool isThreaded() const { return _isThreaded; }
 
    virtual bool process() = 0;
    virtual void setup() {};
    virtual void shutdown() {};
 
public slots:
    void threadRoutine();
 
signals:
    void started();
    void finished();
 
protected:
 
    void lock() { _mutex.lock(); }
 
    void unlock() { _mutex.unlock(); }
 
    bool isStillRunning() const { return !_stopThread; }
 
protected:
    QMutex _mutex;
 
    bool _stopThread;
    bool _isThreaded;
    QThread* _thread;
};
 
#endif // hifi_GenericThread_h