simple_action_server_imp.h

Go to the documentation of this file.

/*********************************************************************
*
* Software License Agreement (BSD License)
*
*  Copyright (c) 2008, 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, Inc. 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: Eitan Marder-Eppstein
*********************************************************************/

namespace actionlib {

  template <class ActionSpec>
  SimpleActionServer<ActionSpec>::SimpleActionServer(std::string name, ExecuteCallback execute_callback, bool auto_start)
    : new_goal_(false), preempt_request_(false), new_goal_preempt_request_(false), execute_callback_(execute_callback), need_to_terminate_(false) {

    if (execute_callback_ != NULL)
    {
      execute_thread_ = new boost::thread(boost::bind(&SimpleActionServer::executeLoop, this));
    }

    //create the action server
    as_ = boost::shared_ptr<ActionServer<ActionSpec> >(new ActionServer<ActionSpec>(n_, name,
          boost::bind(&SimpleActionServer::goalCallback, this, _1),
          boost::bind(&SimpleActionServer::preemptCallback, this, _1),
          auto_start));

  }

  template <class ActionSpec>
  SimpleActionServer<ActionSpec>::SimpleActionServer(std::string name, bool auto_start)
    : new_goal_(false), preempt_request_(false), new_goal_preempt_request_(false), execute_callback_(NULL), need_to_terminate_(false) {

    //create the action server
    as_ = boost::shared_ptr<ActionServer<ActionSpec> >(new ActionServer<ActionSpec>(n_, name,
          boost::bind(&SimpleActionServer::goalCallback, this, _1),
          boost::bind(&SimpleActionServer::preemptCallback, this, _1),
          auto_start));

    if (execute_callback_ != NULL)
    {
      execute_thread_ = new boost::thread(boost::bind(&SimpleActionServer::executeLoop, this));
    }
  }

  template <class ActionSpec>
  SimpleActionServer<ActionSpec>::SimpleActionServer(std::string name, ExecuteCallback execute_callback)
    : new_goal_(false), preempt_request_(false), new_goal_preempt_request_(false), execute_callback_(execute_callback), need_to_terminate_(false) {

    //create the action server
    as_ = boost::shared_ptr<ActionServer<ActionSpec> >(new ActionServer<ActionSpec>(n_, name,
          boost::bind(&SimpleActionServer::goalCallback, this, _1),
          boost::bind(&SimpleActionServer::preemptCallback, this, _1),
          true));

    if (execute_callback_ != NULL)
    {
      execute_thread_ = new boost::thread(boost::bind(&SimpleActionServer::executeLoop, this));
    }
  }


  template <class ActionSpec>
  SimpleActionServer<ActionSpec>::SimpleActionServer(ros::NodeHandle n, std::string name, ExecuteCallback execute_callback, bool auto_start)
    : n_(n), new_goal_(false), preempt_request_(false), new_goal_preempt_request_(false), execute_callback_(execute_callback), need_to_terminate_(false) {

    //create the action server
    as_ = boost::shared_ptr<ActionServer<ActionSpec> >(new ActionServer<ActionSpec>(n, name,
          boost::bind(&SimpleActionServer::goalCallback, this, _1),
          boost::bind(&SimpleActionServer::preemptCallback, this, _1),
          auto_start));

    if (execute_callback_ != NULL)
    {
      execute_thread_ = new boost::thread(boost::bind(&SimpleActionServer::executeLoop, this));
    }
  }

  template <class ActionSpec>
  SimpleActionServer<ActionSpec>::SimpleActionServer(ros::NodeHandle n, std::string name, bool auto_start)
    : n_(n), new_goal_(false), preempt_request_(false), new_goal_preempt_request_(false), execute_callback_(NULL), need_to_terminate_(false) {

    //create the action server
    as_ = boost::shared_ptr<ActionServer<ActionSpec> >(new ActionServer<ActionSpec>(n, name,
          boost::bind(&SimpleActionServer::goalCallback, this, _1),
          boost::bind(&SimpleActionServer::preemptCallback, this, _1),
          auto_start));

    if (execute_callback_ != NULL)
    {
      execute_thread_ = new boost::thread(boost::bind(&SimpleActionServer::executeLoop, this));
    }
  }

  template <class ActionSpec>
  SimpleActionServer<ActionSpec>::SimpleActionServer(ros::NodeHandle n, std::string name, ExecuteCallback execute_callback)
    : n_(n), new_goal_(false), preempt_request_(false), new_goal_preempt_request_(false), execute_callback_(execute_callback), need_to_terminate_(false) {

    //create the action server
    as_ = boost::shared_ptr<ActionServer<ActionSpec> >(new ActionServer<ActionSpec>(n, name,
          boost::bind(&SimpleActionServer::goalCallback, this, _1),
          boost::bind(&SimpleActionServer::preemptCallback, this, _1),
          true));

    if (execute_callback_ != NULL)
    {
      execute_thread_ = new boost::thread(boost::bind(&SimpleActionServer::executeLoop, this));
    }
  }

  template <class ActionSpec>
  SimpleActionServer<ActionSpec>::~SimpleActionServer()
  {
    if(execute_thread_)
      shutdown();
  }

  template <class ActionSpec>
  void SimpleActionServer<ActionSpec>::shutdown()
  {
    if (execute_callback_)
    {
      {
        boost::mutex::scoped_lock terminate_lock(terminate_mutex_);
        need_to_terminate_ = true;
      }

      assert(execute_thread_);
      execute_thread_->join();
      delete execute_thread_;
      execute_thread_ = NULL;
    }
  }

  template <class ActionSpec>
  boost::shared_ptr<const typename SimpleActionServer<ActionSpec>::Goal> SimpleActionServer<ActionSpec>::acceptNewGoal(){
    boost::recursive_mutex::scoped_lock lock(lock_);

    if(!new_goal_ || !next_goal_.getGoal()){
      ROS_ERROR_NAMED("actionlib", "Attempting to accept the next goal when a new goal is not available");
      return boost::shared_ptr<const Goal>();
    }

    //check if we need to send a preempted message for the goal that we're currently pursuing
    if(isActive()
        && current_goal_.getGoal()
        && current_goal_ != next_goal_){
      current_goal_.setCanceled(Result(), "This goal was canceled because another goal was recieved by the simple action server");
    }

    ROS_DEBUG_NAMED("actionlib", "Accepting a new goal");

    //accept the next goal
    current_goal_ = next_goal_;
    new_goal_ = false;

    //set preempt to request to equal the preempt state of the new goal
    preempt_request_ = new_goal_preempt_request_;
    new_goal_preempt_request_ = false;

    //set the status of the current goal to be active
    current_goal_.setAccepted("This goal has been accepted by the simple action server");

    return current_goal_.getGoal();
  }

  template <class ActionSpec>
  bool SimpleActionServer<ActionSpec>::isNewGoalAvailable(){
    return new_goal_;
  }


  template <class ActionSpec>
  bool SimpleActionServer<ActionSpec>::isPreemptRequested(){
    return preempt_request_;
  }

  template <class ActionSpec>
  bool SimpleActionServer<ActionSpec>::isActive(){
    if(!current_goal_.getGoal())
      return false;
    unsigned int status = current_goal_.getGoalStatus().status;
    return status == actionlib_msgs::GoalStatus::ACTIVE || status == actionlib_msgs::GoalStatus::PREEMPTING;
  }

  template <class ActionSpec>
  void SimpleActionServer<ActionSpec>::setSucceeded(const Result& result, const std::string& text){
    boost::recursive_mutex::scoped_lock lock(lock_);
    ROS_DEBUG_NAMED("actionlib", "Setting the current goal as succeeded");
    current_goal_.setSucceeded(result, text);
  }

  template <class ActionSpec>
  void SimpleActionServer<ActionSpec>::setAborted(const Result& result, const std::string& text){
    boost::recursive_mutex::scoped_lock lock(lock_);
    ROS_DEBUG_NAMED("actionlib", "Setting the current goal as aborted");
    current_goal_.setAborted(result, text);
  }

  template <class ActionSpec>
  void SimpleActionServer<ActionSpec>::setPreempted(const Result& result, const std::string& text){
    boost::recursive_mutex::scoped_lock lock(lock_);
    ROS_DEBUG_NAMED("actionlib", "Setting the current goal as canceled");
    current_goal_.setCanceled(result, text);
  }

  template <class ActionSpec>
  void SimpleActionServer<ActionSpec>::registerGoalCallback(boost::function<void ()> cb){
    // Cannot register a goal callback if an execute callback exists
    if (execute_callback_)
      ROS_WARN_NAMED("actionlib", "Cannot call SimpleActionServer::registerGoalCallback() because an executeCallback exists. Not going to register it.");
    else
      goal_callback_ = cb;
  }

  template <class ActionSpec>
  void SimpleActionServer<ActionSpec>::registerPreemptCallback(boost::function<void ()> cb){
    preempt_callback_ = cb;
  }

  template <class ActionSpec>
  void SimpleActionServer<ActionSpec>::publishFeedback(const FeedbackConstPtr& feedback)
  {
    current_goal_.publishFeedback(*feedback);
  }

  template <class ActionSpec>
  void SimpleActionServer<ActionSpec>::publishFeedback(const Feedback& feedback)
  {
    current_goal_.publishFeedback(feedback);
  }

  template <class ActionSpec>
  void SimpleActionServer<ActionSpec>::goalCallback(GoalHandle goal){
    boost::recursive_mutex::scoped_lock lock(lock_);
    ROS_DEBUG_NAMED("actionlib", "A new goal has been recieved by the single goal action server");

    //check that the timestamp is past or equal to that of the current goal and the next goal
    if((!current_goal_.getGoal() || goal.getGoalID().stamp >= current_goal_.getGoalID().stamp)
        && (!next_goal_.getGoal() || goal.getGoalID().stamp >= next_goal_.getGoalID().stamp)){

      //if next_goal has not been accepted already... its going to get bumped, but we need to let the client know we're preempting
      if(next_goal_.getGoal() && (!current_goal_.getGoal() || next_goal_ != current_goal_)){
        next_goal_.setCanceled(Result(), "This goal was canceled because another goal was recieved by the simple action server");
      }

      next_goal_ = goal;
      new_goal_ = true;
      new_goal_preempt_request_ = false;

      //if the server is active, we'll want to call the preempt callback for the current goal
      if(isActive()){
        preempt_request_ = true;
        //if the user has registered a preempt callback, we'll call it now
        if(preempt_callback_)
          preempt_callback_();
      }

      //if the user has defined a goal callback, we'll call it now
      if(goal_callback_)
        goal_callback_();

      // Trigger runLoop to call execute()
      execute_condition_.notify_all();
    }
    else{
      //the goal requested has already been preempted by a different goal, so we're not going to execute it
      goal.setCanceled(Result(), "This goal was canceled because another goal was recieved by the simple action server");
    }
  }

  template <class ActionSpec>
  void SimpleActionServer<ActionSpec>::preemptCallback(GoalHandle preempt){
    boost::recursive_mutex::scoped_lock lock(lock_);
    ROS_DEBUG_NAMED("actionlib", "A preempt has been received by the SimpleActionServer");

    //if the preempt is for the current goal, then we'll set the preemptRequest flag and call the user's preempt callback
    if(preempt == current_goal_){
      ROS_DEBUG_NAMED("actionlib", "Setting preempt_request bit for the current goal to TRUE and invoking callback");
      preempt_request_ = true;

      //if the user has registered a preempt callback, we'll call it now
      if(preempt_callback_)
        preempt_callback_();
    }
    //if the preempt applies to the next goal, we'll set the preempt bit for that
    else if(preempt == next_goal_){
      ROS_DEBUG_NAMED("actionlib", "Setting preempt request bit for the next goal to TRUE");
      new_goal_preempt_request_ = true;
    }
  }

  template <class ActionSpec>
  void SimpleActionServer<ActionSpec>::executeLoop(){

    ros::Duration loop_duration = ros::Duration().fromSec(.1);

    while (n_.ok())
    {
      {
        boost::mutex::scoped_lock terminate_lock(terminate_mutex_);
        if (need_to_terminate_)
          break;
      }

      boost::recursive_mutex::scoped_lock lock(lock_);
      if (isActive())
        ROS_ERROR_NAMED("actionlib", "Should never reach this code with an active goal");
      else if (isNewGoalAvailable())
      {
        GoalConstPtr goal = acceptNewGoal();

        ROS_FATAL_COND(!execute_callback_, "execute_callback_ must exist. This is a bug in SimpleActionServer");

        // Make sure we're not locked when we call execute
        lock.unlock();
        execute_callback_(goal);
        lock.lock();

        if (isActive())
        {
          ROS_WARN_NAMED("actionlib", "Your executeCallback did not set the goal to a terminal status.\n"
                   "This is a bug in your ActionServer implementation. Fix your code!\n"
                   "For now, the ActionServer will set this goal to aborted");
          setAborted(Result(), "This goal was aborted by the simple action server. The user should have set a terminal status on this goal and did not");
        }
      }
      else
        execute_condition_.timed_wait(lock, boost::posix_time::milliseconds(loop_duration.toSec() * 1000.0f));
    }
  }

  template <class ActionSpec>
  void SimpleActionServer<ActionSpec>::start(){
    as_->start();
  }

};