source: src/Fragmentation/Automation/Operations/OperationQueue.hpp@ 9a6b895

/*
 * OperationQueue.hpp
 *
 *  Created on: Apr 24, 2012
 *      Author: heber
 */

#ifndef OPERATIONQUEUE_HPP_
#define OPERATIONQUEUE_HPP_


// include config.h
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <boost/shared_ptr.hpp>
#include <deque>

class AsyncOperation;
class Observer;
class OperationQueueTest;
class WorkerAddress;

/** This class is a container for \ref AsyncOperation's that are kept as shared_ptr
 * and removed when the operation is done.
 */
class OperationQueue
{
  //!> grant unit test access to private part
  friend class OperationQueueTest;
public:
  typedef boost::shared_ptr<AsyncOperation> AsyncOp_ptr;

  /** Add an operation to the internal queue and hand over memory responsibility to it,
   * also the operation is run.
   *
   * @param op operation to add, is NULL on return.
   */
  void push_back(AsyncOperation *&op, const WorkerAddress &address);

  /** Removes an operation from the queue.
   *
   * @param op operation to remove from queue
   * @param observer observer to sign off from operation, NULL if none to sign off
   */
  void remove(AsyncOperation *op, Observer *observer);

private:
  //!> internal operation to send jobs to workers
  typedef std::deque<AsyncOp_ptr> OperationQueue_t;

  /** Tiny Helper function to find an operation inside FragmentScheduler::OperationQueue.
   *
   * @param op operation to remove from queue
   * @return iterator to element or to OperationQueue.end()
   */
  OperationQueue_t::iterator findOperation(AsyncOperation *op);

private:
  //!> internal queue with operations
  OperationQueue_t queue;
};

#endif /* OPERATIONQUEUE_HPP_ */