2019-03-26 15:33:47 +01:00
|
|
|
/* Skip first 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 <villas/hook.hpp>
|
2021-08-10 10:12:48 -04:00
|
|
|
#include <villas/sample.hpp>
|
2023-09-07 11:46:39 +02:00
|
|
|
#include <villas/timing.hpp>
|
2019-03-26 15:33:47 +01:00
|
|
|
|
|
|
|
namespace villas {
|
|
|
|
namespace node {
|
|
|
|
|
|
|
|
class SkipFirstHook : public Hook {
|
|
|
|
|
|
|
|
protected:
|
2023-09-07 11:46:39 +02:00
|
|
|
enum class SkipState {
|
|
|
|
STARTED, // Path just started. First sample not received yet.
|
|
|
|
SKIPPING, // First sample received. Skipping samples now.
|
|
|
|
NORMAL // All samples skipped. Normal operation.
|
|
|
|
} skip_state;
|
|
|
|
|
|
|
|
enum class Mode { SECONDS, SAMPLES } mode;
|
|
|
|
|
|
|
|
union {
|
|
|
|
struct {
|
|
|
|
timespec until;
|
|
|
|
timespec wait; // Absolute point in time from where we accept samples.
|
|
|
|
} seconds;
|
|
|
|
|
|
|
|
struct {
|
|
|
|
uint64_t until;
|
|
|
|
int wait;
|
|
|
|
} samples;
|
|
|
|
};
|
2019-03-26 15:33:47 +01:00
|
|
|
|
|
|
|
public:
|
2023-09-07 11:46:39 +02:00
|
|
|
using Hook::Hook;
|
|
|
|
|
|
|
|
virtual void parse(json_t *json) {
|
|
|
|
double s;
|
|
|
|
|
|
|
|
int ret;
|
|
|
|
json_error_t err;
|
|
|
|
|
|
|
|
assert(state != State::STARTED);
|
|
|
|
|
|
|
|
Hook::parse(json);
|
|
|
|
|
|
|
|
ret = json_unpack_ex(json, &err, 0, "{ s: F }", "seconds", &s);
|
|
|
|
if (!ret) {
|
|
|
|
seconds.wait = time_from_double(s);
|
|
|
|
mode = Mode::SECONDS;
|
|
|
|
|
|
|
|
state = State::PARSED;
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
ret = json_unpack_ex(json, &err, 0, "{ s: i }", "samples", &samples.wait);
|
|
|
|
if (!ret) {
|
|
|
|
mode = Mode::SAMPLES;
|
|
|
|
|
|
|
|
state = State::PARSED;
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
throw ConfigError(json, err, "node-config-hook-skip_first");
|
|
|
|
}
|
|
|
|
|
|
|
|
virtual void start() {
|
|
|
|
skip_state = SkipState::STARTED;
|
|
|
|
state = State::STARTED;
|
|
|
|
}
|
|
|
|
|
|
|
|
virtual void restart() { skip_state = SkipState::STARTED; }
|
|
|
|
|
|
|
|
virtual Hook::Reason process(struct Sample *smp) {
|
|
|
|
assert(state == State::STARTED);
|
|
|
|
|
|
|
|
// Remember sequence no or timestamp of first sample.
|
|
|
|
if (skip_state == SkipState::STARTED) {
|
|
|
|
switch (mode) {
|
|
|
|
case Mode::SAMPLES:
|
|
|
|
samples.until = smp->sequence + samples.wait;
|
|
|
|
break;
|
|
|
|
|
|
|
|
case Mode::SECONDS:
|
|
|
|
seconds.until = time_add(&smp->ts.origin, &seconds.wait);
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
|
|
|
skip_state = SkipState::SKIPPING;
|
|
|
|
}
|
|
|
|
|
|
|
|
switch (mode) {
|
|
|
|
case Mode::SAMPLES:
|
|
|
|
if (samples.until > smp->sequence)
|
|
|
|
return Hook::Reason::SKIP_SAMPLE;
|
|
|
|
break;
|
|
|
|
|
|
|
|
case Mode::SECONDS:
|
|
|
|
if (time_delta(&seconds.until, &smp->ts.origin) < 0)
|
|
|
|
return Hook::Reason::SKIP_SAMPLE;
|
|
|
|
break;
|
|
|
|
|
|
|
|
default:
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
|
|
|
return Reason::OK;
|
|
|
|
}
|
2019-03-26 15:33:47 +01:00
|
|
|
};
|
|
|
|
|
|
|
|
// Register hook
|
2020-06-14 15:00:02 +02:00
|
|
|
static char n[] = "skip_first";
|
|
|
|
static char d[] = "Skip the first samples";
|
2023-09-07 11:46:39 +02:00
|
|
|
static HookPlugin<SkipFirstHook, 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
|
|
|
|
2023-08-28 09:34:02 +02:00
|
|
|
} // namespace node
|
|
|
|
} // namespace villas
|