MeVis/Foundation/Sources/MLBackgroundTasks/mlBackgroundTaskMessageQueue.h

Go to the documentation of this file.

// **InsertLicense** code
//----------------------------------------------------------------------------------
//----------------------------------------------------------------------------------


#ifndef __mlBackgroundTaskMessageQueue_H
#define __mlBackgroundTaskMessageQueue_H


// Local includes
#include "MLBackgroundTasksSystem.h"

#include "mlModuleIncludes.h"

#include <deque>
#include <boost/thread/mutex.hpp>
#include <boost/thread/condition.hpp>

ML_START_NAMESPACE

//-----------------------------------------------------------------------

class BackgroundTaskMessage;

class MLBACKGROUNDTASKS_EXPORT BackgroundTaskMessageQueue
{
  ML_DISALLOW_COPY_AND_ASSIGN(BackgroundTaskMessageQueue)

public:
  BackgroundTaskMessageQueue();
  ~BackgroundTaskMessageQueue();

  BackgroundTaskMessage* waitForMessage();

  void addMessage(BackgroundTaskMessage* message);

  BackgroundTaskMessage* nextMessage();

  BackgroundTaskMessage* nextMessage(int& availableMessages);

  BackgroundTaskMessage* nextMessageNoLock();

  bool isCanceled() const { return _isCanceled; }

  void cancel();

  void cancelAndNotify();

private:
  std::deque<BackgroundTaskMessage*> _queue;
  boost::mutex         _mutex;
  boost::condition     _messageAvailable;

  bool _isCanceled;
};

ML_END_NAMESPACE

#endif