1 /** 2 * Copyright © 2021 IBM Corporation 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 #pragma once 17 18 #include "../manager.hpp" 19 #include "action.hpp" 20 #include "trigger_aliases.hpp" 21 22 #include <nlohmann/json.hpp> 23 #include <sdbusplus/message.hpp> 24 25 #include <functional> 26 #include <memory> 27 #include <unordered_map> 28 #include <vector> 29 30 namespace phosphor::fan::control::json::trigger::signal 31 { 32 33 using json = nlohmann::json; 34 35 /** 36 * @brief Subscribe to a signal 37 * 38 * @param[in] match - Signal match string to subscribe to 39 * @param[in] pkg - Data package to attach to signal 40 * @param[in] mgr - Pointer to manager of the trigger 41 */ 42 void subscribe(const std::string& match, SignalPkg&& pkg, 43 std::function<bool(SignalPkg&)> isSameSig, Manager* mgr); 44 45 /** 46 * @brief Subscribes to a propertiesChanged signal 47 * 48 * @param[in] mgr - Pointer to manager of the trigger 49 * @param[in] action - Action to be run when signal is received 50 */ 51 void propertiesChanged(Manager* mgr, std::unique_ptr<ActionBase>& action, 52 const json&); 53 54 /** 55 * @brief Subscribes to an interfacesAdded signal 56 * 57 * @param[in] mgr - Pointer to manager of the trigger 58 * @param[in] action - Action to be run when signal is received 59 */ 60 void interfacesAdded(Manager* mgr, std::unique_ptr<ActionBase>& action, 61 const json&); 62 63 /** 64 * @brief Subscribes to an interfacesRemoved signal 65 * 66 * @param[in] mgr - Pointer to manager of the trigger 67 * @param[in] action - Action to be run when signal is received 68 */ 69 void interfacesRemoved(Manager* mgr, std::unique_ptr<ActionBase>& action, 70 const json&); 71 72 /** 73 * @brief Subscribes to a nameOwnerChanged signal 74 * 75 * @param[in] mgr - Pointer to manager of the trigger 76 * @param[in] action - Action to be run when signal is received 77 */ 78 void nameOwnerChanged(Manager* mgr, std::unique_ptr<ActionBase>& action, 79 const json&); 80 81 /** 82 * @brief Subscribes to a dbus member signal 83 * 84 * @param[in] mgr - Pointer to manager of the trigger 85 * @param[in] action - Action to be run when signal is received 86 * @param[in] jsonObj - JSON object for the trigger 87 */ 88 void member(Manager* mgr, std::unique_ptr<ActionBase>& action, 89 const json& jsonObj); 90 91 // Match setup function for signals 92 using SignalMatch = std::function<void( 93 Manager*, std::unique_ptr<ActionBase>& action, const json&)>; 94 95 /* Supported signals to their corresponding match setup functions */ 96 static const std::unordered_map<std::string, SignalMatch> signals = { 97 {"properties_changed", propertiesChanged}, 98 {"interfaces_added", interfacesAdded}, 99 {"interfaces_removed", interfacesRemoved}, 100 {"name_owner_changed", nameOwnerChanged}, 101 {"member", member}}; 102 103 /** 104 * @brief Trigger to process an event after a signal is received 105 * 106 * @param[in] jsonObj - JSON object for the trigger 107 * @param[in] eventName - Name of event associated to the signal 108 * @param[in] actions - Actions associated with the trigger 109 * 110 * When fan control starts (or restarts), all events with 'signal' triggers are 111 * subscribed to run its corresponding actions when a signal, per its 112 * configuration, is received. 113 */ 114 enableTrigger triggerSignal(const json& jsonObj, const std::string& eventName, 115 std::vector<std::unique_ptr<ActionBase>>& actions); 116 117 } // namespace phosphor::fan::control::json::trigger::signal 118