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/include/villas/hook.h

107 lines
3.1 KiB
C
Raw Permalink Normal View History

/** Hook funktions
*
* Every path can register a hook function which is called for every received
* message. This can be used to debug the data flow, get statistics
* or alter the message.
*
* This file includes some examples.
*
* @file
2015-06-02 21:53:04 +02:00
* @author Steffen Vogel <stvogel@eonerc.rwth-aachen.de>
* @copyright 2017, Institute for Automation of Complex Power Systems, EONERC
2017-04-27 12:56:43 +02:00
* @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.
*
2017-04-27 12:56:43 +02:00
* 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.
*
2017-04-27 12:56:43 +02:00
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
2015-09-19 18:48:00 +02:00
*/
/**
* @addtogroup hooks User-defined hook functions
2015-09-19 18:48:00 +02:00
* @ingroup path
* @{
2015-06-02 21:53:04 +02:00
*********************************************************************************/
2017-02-18 10:47:15 -05:00
#pragma once
#include <villas/hook_type.h>
#include <villas/common.h>
2017-02-18 10:49:42 -05:00
#ifdef __cplusplus
extern "C" {
#endif
/* Forward declarations */
struct path;
struct sample;
struct list;
2017-03-17 01:08:48 -03:00
2015-09-19 18:48:00 +02:00
/** Descriptor for user defined hooks. See hooks[]. */
struct hook {
2018-06-29 08:37:14 +02:00
enum state state;
2018-06-29 08:37:14 +02:00
struct path *path;
struct node *node;
2018-06-29 08:37:14 +02:00
struct hook_type *_vt; /**< C++ like Vtable pointer. */
void *_vd; /**< Private data for this hook. This pointer can be used to pass data between consecutive calls of the callback. */
2018-06-29 08:37:14 +02:00
int priority; /**< A priority to change the order of execution within one type of hook. */
2018-06-29 08:37:14 +02:00
json_t *cfg; /**< A JSON object containing the configuration of the hook. */
};
int hook_init(struct hook *h, struct hook_type *vt, struct path *p, struct node *n);
int hook_parse(struct hook *h, json_t *cfg);
int hook_parse_cli(struct hook *h, int argc, char *argv[]);
2017-03-17 01:08:48 -03:00
int hook_destroy(struct hook *h);
2017-03-27 12:26:11 +02:00
int hook_start(struct hook *h);
int hook_stop(struct hook *h);
int hook_periodic(struct hook *h);
int hook_restart(struct hook *h);
int hook_read(struct hook *h, struct sample *smps[], unsigned *cnt);
int hook_process(struct hook *h, struct sample *smps[], unsigned *cnt);
int hook_write(struct hook *h, struct sample *smps[], unsigned *cnt);
2017-03-27 12:26:11 +02:00
int hook_read_list(struct list *hs, struct sample *smps[], unsigned cnt);
int hook_process_list(struct list *hs, struct sample *smps[], unsigned cnt);
int hook_write_list(struct list *hs, struct sample *smps[], unsigned cnt);
2017-03-27 12:26:11 +02:00
/** Compare two hook functions with their priority. Used by list_sort() */
int hook_cmp_priority(const void *a, const void *b);
/** Parses an object of hooks
*
* Example:
*
* {
* stats = {
* output = "stdout"
* },
* skip_first = {
* seconds = 10
* },
* hooks = [ "print" ]
* }
*/
int hook_parse_list(struct list *list, json_t *cfg, struct path *p, struct node *n);
#ifdef __cplusplus
}
2018-06-29 08:37:14 +02:00
#endif