mirror of
https://git.rwth-aachen.de/acs/public/villas/node/
synced 2025-03-09 00:00:00 +01:00
106 lines
2.5 KiB
C++
106 lines
2.5 KiB
C++
/** Rate-limiting hook.
|
|
*
|
|
* @author Steffen Vogel <stvogel@eonerc.rwth-aachen.de>
|
|
* @copyright 2014-2020, Institute for Automation of Complex Power Systems, EONERC
|
|
* @license GNU General Public License (version 3)
|
|
*
|
|
* VILLASnode
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*********************************************************************************/
|
|
|
|
/** @addtogroup hooks Hook functions
|
|
* @{
|
|
*/
|
|
|
|
#include <cstring>
|
|
|
|
#include <villas/timing.h>
|
|
#include <villas/sample.h>
|
|
#include <villas/hooks/limit_rate.hpp>
|
|
|
|
namespace villas {
|
|
namespace node {
|
|
|
|
void LimitRateHook::parse(json_t *json)
|
|
{
|
|
int ret;
|
|
json_error_t err;
|
|
|
|
assert(state != State::STARTED);
|
|
|
|
double rate;
|
|
const char *m = nullptr;
|
|
|
|
Hook::parse(json);
|
|
|
|
ret = json_unpack_ex(json, &err, 0, "{ s: F, s?: s }",
|
|
"rate", &rate,
|
|
"mode", &m
|
|
);
|
|
if (ret)
|
|
throw ConfigError(json, err, "node-config-hook-limit_rate");
|
|
|
|
if (m) {
|
|
if (!strcmp(m, "origin"))
|
|
mode = LIMIT_RATE_ORIGIN;
|
|
else if (!strcmp(m, "received"))
|
|
mode = LIMIT_RATE_RECEIVED;
|
|
else if (!strcmp(m, "local"))
|
|
mode = LIMIT_RATE_LOCAL;
|
|
else
|
|
throw ConfigError(json, "node-config-hook-limit_rate-mode", "Invalid value '{}' for setting 'mode'", mode);
|
|
}
|
|
|
|
deadtime = 1.0 / rate;
|
|
|
|
state = State::PARSED;
|
|
}
|
|
|
|
Hook::Reason LimitRateHook::process(sample *smp)
|
|
{
|
|
assert(state == State::STARTED);
|
|
|
|
timespec next;
|
|
switch (mode) {
|
|
case LIMIT_RATE_LOCAL:
|
|
next = time_now();
|
|
break;
|
|
|
|
case LIMIT_RATE_ORIGIN:
|
|
next = smp->ts.origin;
|
|
break;
|
|
|
|
case LIMIT_RATE_RECEIVED:
|
|
next = smp->ts.received;
|
|
break;
|
|
}
|
|
|
|
if (time_delta(&last, &next) < deadtime)
|
|
return Hook::Reason::SKIP_SAMPLE;
|
|
|
|
last = next;
|
|
|
|
return Reason::OK;
|
|
}
|
|
|
|
/* Register hook */
|
|
static char n[] = "limit_rate";
|
|
static char d[] = "Limit sending rate";
|
|
static HookPlugin<LimitRateHook, n, d, (int) Hook::Flags::NODE_READ | (int) Hook::Flags::NODE_WRITE | (int) Hook::Flags::PATH> p;
|
|
|
|
} /* namespace node */
|
|
} /* namespace villas */
|
|
|
|
/** @} */
|