coordinator.hpp

Go to the documentation of this file.

/*
 * Copyright 2020 Robert Bosch GmbH
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
#pragma once
 
#include <list>    // for list<>
#include <map>     // for map<>
#include <memory>  // for unique_ptr<>, shared_ptr<>
#include <mutex>   // for mutex
#include <queue>   // for queue<>
#include <string>  // for string
#include <vector>  // for vector<>
 
#include <sol/state_view.hpp>  // for state_view
#include <sol/table.hpp>       // for table
 
#include <cloe/cloe_fwd.hpp>  // for Registrar, DataBroker
#include <cloe/trigger.hpp>   // for Trigger, Action, Event, ...
 
namespace engine {
 
// Forward declarations:
class TriggerRegistrar;  // from coordinator.cpp
 
class TriggerUnknownAction : public cloe::TriggerInvalid {
 public:
  TriggerUnknownAction(const std::string& key, const cloe::Conf& c)
      : TriggerInvalid(c, "unknown action: " + key), key_(key) {}
  ~TriggerUnknownAction() noexcept override = default;
 
  [[nodiscard]] const char* key() const { return key_.c_str(); }
 
 private:
  std::string key_;
};
 
class TriggerUnknownEvent : public cloe::TriggerInvalid {
 public:
  TriggerUnknownEvent(const std::string& key, const cloe::Conf& c)
      : TriggerInvalid(c, "unknown event: " + key), key_(key) {}
  virtual ~TriggerUnknownEvent() noexcept = default;
 
  [[nodiscard]] const char* key() const { return key_.c_str(); }
 
 private:
  std::string key_;
};
 
struct HistoryTrigger {
  HistoryTrigger(cloe::Duration d, cloe::TriggerPtr&& t) : when(d), what(std::move(t)) {}
 
  friend void to_json(cloe::Json& j, const HistoryTrigger& t);
 
 public:
  cloe::Duration when;
  cloe::TriggerPtr what;
};
 
class Coordinator {
 public:
  Coordinator(sol::state_view lua, cloe::DataBroker* db);
 
  const std::vector<HistoryTrigger>& history() const { return history_; }
 
  void register_action(const std::string& key, cloe::ActionFactoryPtr&& af);
 
  void register_event(const std::string& key, cloe::EventFactoryPtr&& ef,
                      std::shared_ptr<cloe::Callback> storage);
 
  [[nodiscard]] sol::table register_lua_table(const std::string& field);
 
  [[nodiscard]] cloe::DataBroker* data_broker() const { return db_; }
 
  std::shared_ptr<cloe::TriggerRegistrar> trigger_registrar(cloe::Source s);
 
  void enroll(cloe::Registrar& r);
 
  [[nodiscard]] cloe::Logger logger() const { return cloe::logger::get("cloe"); }
 
  [[nodiscard]] std::map<std::string, fable::Json> trigger_action_schemas() const;
 
  [[nodiscard]] std::map<std::string, fable::Json> trigger_event_schemas() const;
 
  cloe::Duration process(const cloe::Sync&);
 
  size_t process_pending_lua_triggers(const cloe::Sync& sync);
  size_t process_pending_web_triggers(const cloe::Sync& sync);
 
  void insert_trigger_from_lua(const cloe::Sync& sync, const sol::object& obj);
  void execute_action_from_lua(const cloe::Sync& sync, const sol::object& obj);
 
 protected:
  [[nodiscard]] cloe::ActionPtr make_action(const sol::object& lua) const;
  [[nodiscard]] cloe::ActionPtr make_action(const cloe::Conf& c) const;
  [[nodiscard]] cloe::EventPtr make_event(const cloe::Conf& c) const;
  [[nodiscard]] cloe::TriggerPtr make_trigger(cloe::Source s, const cloe::Conf& c) const;
  [[nodiscard]] cloe::TriggerPtr make_trigger(const sol::table& tbl) const;
  void queue_trigger(cloe::Source s, const cloe::Conf& c) { queue_trigger(make_trigger(s, c)); }
  void queue_trigger(cloe::TriggerPtr&& tp);
  void store_trigger(cloe::TriggerPtr&& tp, const cloe::Sync& sync);
  cloe::CallbackResult execute_trigger(cloe::TriggerPtr&& tp, const cloe::Sync& sync);
 
  // for access to protected methods
  friend TriggerRegistrar;
 
 private:
  // Options:
  bool allow_errors_ = false;
 
  // Factories:
  std::map<std::string, cloe::ActionFactoryPtr> actions_;
  std::map<std::string, cloe::EventFactoryPtr> events_;
  sol::state_view lua_;
  cloe::DataBroker* db_;  // non-owning
 
  // Execution:
  std::shared_ptr<cloe::TriggerRegistrar> executer_registrar_;
 
  // Storage:
  std::map<std::string, std::shared_ptr<cloe::Callback>> storage_;
 
  // Input:
  std::list<cloe::TriggerPtr> input_queue_;
  mutable std::mutex input_mutex_;
 
  // History:
  std::vector<HistoryTrigger> history_;
};
 
void register_usertype_coordinator(sol::table& lua, const cloe::Sync& sync);
 
}  // namespace engine