MQTTSuite
Loading...
Searching...
No Matches
MqttMapperPlugin.h
Go to the documentation of this file.
1/*
2 * MQTTSuite - A lightweight MQTT Integration System
3 * Copyright (C) Volker Christian <me@vchrist.at>
4 * 2022, 2023, 2024, 2025
5 *
6 * This program is free software: you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the Fre
8 * Software Foundation, either version 3 of the License, or (at your option)
9 * any later version.
10 *
11 * This program is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * more details.
15 *
16 * You should have received a copy of the GNU General Public License along
17 * with this program. If not, see <https://www.gnu.org/licenses/>.
18 */
19
20/*
21 * MIT License
22 *
23 * Permission is hereby granted, free of charge, to any person obtaining a copy
24 * of this software and associated documentation files (the "Software"), to deal
25 * in the Software without restriction, including without limitation the rights
26 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
27 * copies of the Software, and to permit persons to whom the Software is
28 * furnished to do so, subject to the following conditions:
29 *
30 * The above copyright notice and this permission notice shall be included in
31 * all copies or substantial portions of the Software.
32 *
33 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
34 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
35 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
36 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
37 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
38 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
39 * THE SOFTWARE.
40 */
41
42#ifndef MQTT_LIB_MQTTMAPPERPLUGIN_H
43#define MQTT_LIB_MQTTMAPPERPLUGIN_H
44
45// #include "MqttMapper.h" // IWYU pragma: export
46
47#ifndef DOXYGEN_SHOULD_SKIP_THIS
48
49#include <algorithm>
50#include <functional>
51#include <nlohmann/json_fwd.hpp> // IWYU pragma: export
52#include <vector>
53
54#endif // DOXYGEN_SHOULD_SKIP_THIS
55
56namespace inja {
57 using Arguments = std::vector<const nlohmann::json*>;
58 using json = nlohmann::json;
59} // namespace inja
60
61namespace mqtt::lib {
62 struct FunctionBase {
63 FunctionBase(const std::string& name, int numArgs)
64 : name(name)
65 , numArgs(numArgs) {
66 }
67
68 std::string name;
70 };
71
73 Function(const std::string& name, int numArgs, const std::function<inja::json(inja::Arguments&)>& function)
74 : FunctionBase(name, numArgs)
75 , function(function) {
76 }
77
78 std::function<inja::json(inja::Arguments&)> function;
79 };
80
82 VoidFunction(const std::string& name, int numArgs, const std::function<void(inja::Arguments&)>& function)
83 : FunctionBase(name, numArgs)
84 , function(function) {
85 }
86
87 std::function<void(inja::Arguments&)> function;
88 };
89
90} // namespace mqtt::lib
91
92extern "C" std::vector<mqtt::lib::Function> functions;
93extern "C" std::vector<mqtt::lib::VoidFunction> voidFunctions;
94
95#endif // MQTT_LIB_MQTTMAPPERPLUGIN_H
std::vector< mqtt::lib::Function > functions
Definition Double.cpp:80
std::vector< mqtt::lib::VoidFunction > voidFunctions
Class for changing the configuration.
Definition inja.hpp:2851
void publishMappedTemplate(const nlohmann::json &templateMapping, nlohmann::json &json)
static void extractSubscription(const nlohmann::json &topicLevelJson, const std::string &topic, std::list< iot::mqtt::Topic > &topicList)
MqttMapper & operator=(const MqttMapper &)=delete
void publishMappedMessage(const nlohmann::json &staticMapping, const iot::mqtt::packets::Publish &publish)
void publishMappings(const iot::mqtt::packets::Publish &publish)
void publishMappedMessage(const std::string &topic, const std::string &message, uint8_t qoS, bool retain)
nlohmann::json findMatchingTopicLevel(const nlohmann::json &topicLevel, const std::string &topic)
void publishMappedMessages(const nlohmann::json &staticMapping, const iot::mqtt::packets::Publish &publish)
virtual void publishMapping(const std::string &topic, const std::string &message, uint8_t qoS, bool retain)=0
const nlohmann::json & mappingJson
Definition MqttMapper.h:99
std::list< void * > pluginHandles
Definition MqttMapper.h:101
void publishMappedTemplates(const nlohmann::json &templateMapping, nlohmann::json &json, const iot::mqtt::packets::Publish &publish)
inja::Environment * injaEnvironment
Definition MqttMapper.h:103
MqttMapper(const nlohmann::json &mappingJson)
MqttMapper(const MqttMapper &)=delete
std::list< iot::mqtt::Topic > extractSubscriptions()
static void extractSubscriptions(const nlohmann::json &mappingJson, const std::string &topic, std::list< iot::mqtt::Topic > &topicList)
std::vector< const nlohmann::json * > Arguments
nlohmann::json json
const std::string type
Definition inja.hpp:256
const SourceLocation location
Definition inja.hpp:259
const std::string message
Definition inja.hpp:257
FunctionBase(const std::string &name, int numArgs)
Function(const std::string &name, int numArgs, const std::function< inja::json(inja::Arguments &)> &function)
VoidFunction(const std::string &name, int numArgs, const std::function< void(inja::Arguments &)> &function)