WorkerOptions.hpp

Go to the documentation of this file.

/**********************************************************************
 * Software License Agreement (BSD License)
 *
 * Copyright (c) 2016, Philipp Leemann
 * 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 Robotic Systems Lab nor ETH Zurich
 *     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.
 */

#pragma once

#include <atomic>
#include <string>

#include "bota_worker/RateOptions.hpp"
#include "bota_worker/WorkerEvent.hpp"

namespace bota_worker
{
using WorkerCallback = std::function<bool(const WorkerEvent&)>;
using WorkerCallbackFailureReaction = std::function<void(void)>;

struct WorkerOptions : public RateOptions
{
  WorkerOptions()
    : RateOptions(), callback_(), callbackFailureReaction_([]() {}), defaultPriority_(0), destructWhenDone_(false)
  {
  }

  WorkerOptions(const std::string& name, const double timestep, WorkerCallback callback, const int priority = 0)
    : RateOptions(name, timestep)
    , callback_(std::move(callback))
    , callbackFailureReaction_([]() {})
    , defaultPriority_(priority)
    , destructWhenDone_(false)
  {
  }

  WorkerOptions(const std::string& name, const double timestep, WorkerCallback callback,
                WorkerCallbackFailureReaction callbackFailureReaction, const int priority = 0)
    : RateOptions(name, timestep)
    , callback_(std::move(callback))
    , callbackFailureReaction_(std::move(callbackFailureReaction))
    , defaultPriority_(priority)
    , destructWhenDone_(false)
  {
  }

  WorkerOptions(const WorkerOptions& other) = default;

  WorkerOptions(WorkerOptions&& other) noexcept
    : RateOptions(std::move(other))
    , callback_(std::move(other.callback_))
    , callbackFailureReaction_(std::move(other.callbackFailureReaction_))
    , defaultPriority_(other.defaultPriority_)
    , destructWhenDone_(other.destructWhenDone_)
  {
  }

  WorkerCallback callback_;

  WorkerCallbackFailureReaction callbackFailureReaction_;

  int defaultPriority_;

  bool destructWhenDone_;
};

}  // namespace bota_worker