background_processing.h

Go to the documentation of this file.

/*********************************************************************
 * Software License Agreement (BSD License)
 *
 *  Copyright (c) 2012, Willow Garage, Inc.
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above
 *     copyright notice, this list of conditions and the following
 *     disclaimer in the documentation and/or other materials provided
 *     with the distribution.
 *   * Neither the name of Willow Garage nor the names of its
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 *********************************************************************/

/* Author: Ioan Sucan */

#ifndef MOVEIT_BACKGROUND_PROCESSING_
#define MOVEIT_BACKGROUND_PROCESSING_

#include <deque>
#include <string>
#include <boost/thread.hpp>
#include <boost/function.hpp>
#include <boost/scoped_ptr.hpp>
#include <boost/noncopyable.hpp>

namespace moveit
{

namespace tools
{

class BackgroundProcessing : private boost::noncopyable
{
public:

  enum JobEvent
    {
      ADD,
      REMOVE,
      COMPLETE
    };

  typedef boost::function<void(JobEvent, const std::string&)> JobUpdateCallback;

  typedef boost::function<void()> JobCallback;

  BackgroundProcessing();

  ~BackgroundProcessing();

  void addJob(const JobCallback &job, const std::string &name);

  std::size_t getJobCount() const;

  void clear();

  void setJobUpdateEvent(const JobUpdateCallback &event);

  void clearJobUpdateEvent();

private:

  boost::scoped_ptr<boost::thread> processing_thread_;
  bool run_processing_thread_;

  mutable boost::mutex action_lock_;
  boost::condition_variable new_action_condition_;
  std::deque<JobCallback> actions_;
  std::deque<std::string> action_names_;

  JobUpdateCallback queue_change_event_;

  bool processing_;

  void processingThread();
};

}
}

#endif