1
0
Fork 0
mirror of https://git.rwth-aachen.de/acs/public/villas/node/ synced 2025-03-09 00:00:00 +01:00
VILLASnode/lib/hooks/limit_rate.cpp

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

86 lines
1.9 KiB
C++
Raw Permalink Normal View History

2019-03-26 15:33:47 +01:00
/* Rate-limiting hook.
*
2022-03-15 09:18:01 -04:00
* Author: Steffen Vogel <post@steffenvogel.de>
2022-03-15 09:28:57 -04:00
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
2022-07-04 18:20:03 +02:00
* SPDX-License-Identifier: Apache-2.0
2019-03-26 15:33:47 +01:00
*/
#include <cstring>
2019-03-26 15:33:47 +01:00
#include <villas/hooks/limit_rate.hpp>
#include <villas/sample.hpp>
#include <villas/timing.hpp>
2019-03-26 15:33:47 +01:00
namespace villas {
namespace node {
void LimitRateHook::parse(json_t *json) {
int ret;
json_error_t err;
2019-03-26 15:33:47 +01:00
assert(state != State::STARTED);
2019-03-26 15:33:47 +01:00
double rate;
const char *m = nullptr;
2019-03-26 15:33:47 +01:00
Hook::parse(json);
2020-08-28 19:49:36 +02:00
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");
2019-03-26 15:33:47 +01:00
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'", m);
}
2019-03-26 15:33:47 +01:00
deadtime = 1.0 / rate;
2019-03-26 15:33:47 +01:00
state = State::PARSED;
2019-03-26 15:33:47 +01:00
}
Hook::Reason LimitRateHook::process(struct Sample *smp) {
assert(state == State::STARTED);
2019-03-26 15:33:47 +01:00
timespec next;
switch (mode) {
case LIMIT_RATE_LOCAL:
next = time_now();
break;
2019-03-26 15:33:47 +01:00
case LIMIT_RATE_ORIGIN:
next = smp->ts.origin;
break;
2019-03-26 15:33:47 +01:00
case LIMIT_RATE_RECEIVED:
next = smp->ts.received;
break;
}
2019-03-26 15:33:47 +01:00
if (time_delta(&last, &next) < deadtime)
return Hook::Reason::SKIP_SAMPLE;
2019-03-26 15:33:47 +01:00
last = next;
2019-03-26 15:33:47 +01:00
return Reason::OK;
2019-03-26 15:33:47 +01:00
}
// 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;
2019-03-26 15:33:47 +01:00
} // namespace node
} // namespace villas