/** Rate-limiting hook. * * @author Steffen Vogel * @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 . *********************************************************************************/ /** @addtogroup hooks Hook functions * @{ */ #include #include #include #include namespace villas { namespace node { void LimitRateHook::parse(json_t *cfg) { int ret; json_error_t err; assert(state != State::STARTED); double rate; const char *m = nullptr; Hook::parse(cfg); ret = json_unpack_ex(cfg, &err, 0, "{ s: F, s?: s }", "rate", &rate, "mode", &m ); if (ret) throw ConfigError(cfg, 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(cfg, "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 p; } /* namespace node */ } /* namespace villas */ /** @} */