mlBackgroundTaskMessageQueue.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2009, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
#ifndef ML_BACKGROUND_TASK_MESSAGE_QUEUE_H
#define ML_BACKGROUND_TASK_MESSAGE_QUEUE_H
 
// Local includes
#include "MLBackgroundTasksSystem.h"
 
#include <ThirdPartyWarningsDisable.h>
#include <deque>
#include <boost/thread/mutex.hpp>
#include <boost/thread/condition.hpp>
#include <ThirdPartyWarningsRestore.h>
 
ML_START_NAMESPACE
 
//-----------------------------------------------------------------------
 
class BackgroundTaskMessage;
class BackgroundTaskMessageReceiver;
 
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();

  void removeMessagesForReceiver(BackgroundTaskMessageReceiver* receiver);

  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