mirror of
https://git.rwth-aachen.de/acs/public/villas/node/
synced 2025-03-30 00:00:11 +01:00
147 lines
No EOL
4 KiB
C
147 lines
No EOL
4 KiB
C
/** Message paths
|
|
*
|
|
* @file
|
|
* @author Steffen Vogel <stvogel@eonerc.rwth-aachen.de>
|
|
* @copyright 2017, Institute for Automation of Complex Power Systems, EONERC
|
|
*********************************************************************************/
|
|
|
|
/** A path connects one input node to multiple output nodes (1-to-n).
|
|
*
|
|
* @addtogroup path Path
|
|
* @{
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <pthread.h>
|
|
#include <libconfig.h>
|
|
|
|
#include "list.h"
|
|
#include "config.h"
|
|
#include "hist.h"
|
|
#include "node.h"
|
|
#include "msg.h"
|
|
#include "queue.h"
|
|
#include "pool.h"
|
|
#include "stats.h"
|
|
#include "common.h"
|
|
|
|
/* Forward declarations */
|
|
struct super_node;
|
|
struct hook_info;
|
|
|
|
struct path_source
|
|
{
|
|
struct node *node;
|
|
struct pool pool;
|
|
int samplelen;
|
|
pthread_t tid;
|
|
};
|
|
|
|
struct path_destination
|
|
{
|
|
struct node *node;
|
|
struct queue queue;
|
|
int queuelen;
|
|
pthread_t tid;
|
|
};
|
|
|
|
/** The datastructure for a path. */
|
|
struct path
|
|
{
|
|
enum state state; /**< Path state. */
|
|
|
|
/* Each path has a single source and multiple destinations */
|
|
struct path_source *source; /**< Pointer to the incoming node */
|
|
struct list destinations; /**< List of all outgoing nodes (struct path_destination). */
|
|
|
|
struct list hooks; /**< List of function pointers to hooks. */
|
|
|
|
int enabled; /**< Is this path enabled. */
|
|
int reverse; /**< This path as a matching reverse path. */
|
|
|
|
pthread_t tid; /**< The thread id for this path. */
|
|
|
|
char *_name; /**< Singleton: A string which is used to print this path to screen. */
|
|
|
|
struct stats *stats; /**< Statistic counters. This is a pointer to the statistic hooks private data. */
|
|
|
|
struct super_node *super_node; /**< The super node this path belongs to. */
|
|
config_setting_t *cfg; /**< A pointer to the libconfig object which instantiated this path. */
|
|
};
|
|
|
|
/** Initialize internal data structures. */
|
|
int path_init(struct path *p, struct super_node *sn);
|
|
|
|
int path_init2(struct path *p);
|
|
|
|
/** Check if path configuration is proper. */
|
|
int path_check(struct path *p);
|
|
|
|
/** Start a path.
|
|
*
|
|
* Start a new pthread for receiving/sending messages over this path.
|
|
*
|
|
* @param p A pointer to the path structure.
|
|
* @retval 0 Success. Everything went well.
|
|
* @retval <0 Error. Something went wrong.
|
|
*/
|
|
int path_start(struct path *p);
|
|
|
|
/** Stop a path.
|
|
*
|
|
* @param p A pointer to the path structure.
|
|
* @retval 0 Success. Everything went well.
|
|
* @retval <0 Error. Something went wrong.
|
|
*/
|
|
int path_stop(struct path *p);
|
|
|
|
/** Destroy path by freeing dynamically allocated memory.
|
|
*
|
|
* @param i A pointer to the path structure.
|
|
*/
|
|
int path_destroy(struct path *p);
|
|
|
|
/** Show some basic statistics for a path.
|
|
*
|
|
* @param p A pointer to the path structure.
|
|
*/
|
|
void path_print_stats(struct path *p);
|
|
|
|
/** Fills the provided buffer with a string representation of the path.
|
|
*
|
|
* Format: source => [ dest1 dest2 dest3 ]
|
|
*
|
|
* @param p A pointer to the path structure.
|
|
* @return A pointer to a string containing a textual representation of the path.
|
|
*/
|
|
const char * path_name(struct path *p);
|
|
|
|
/** Reverse a path */
|
|
int path_reverse(struct path *p, struct path *r);
|
|
|
|
/** Check if node is used as source or destination of a path. */
|
|
int path_uses_node(struct path *p, struct node *n);
|
|
|
|
/** Parse a single path and add it to the global configuration.
|
|
*
|
|
* @param cfg A libconfig object pointing to the path
|
|
* @param p Pointer to the allocated memory for this path
|
|
* @param nodes A linked list of all existing nodes
|
|
* @retval 0 Success. Everything went well.
|
|
* @retval <0 Error. Something went wrong.
|
|
*/
|
|
int path_parse(struct path *p, config_setting_t *cfg, struct list *nodes);
|
|
|
|
/** Conditionally execute the hooks
|
|
*
|
|
* @param p A pointer to the path structure.
|
|
* @param when Which type of hooks should be executed?
|
|
* @param smps An array to of (cnt) pointers to msgs.
|
|
* @param cnt The size of the sample array.
|
|
* @retval 0 All registred hooks for the specified type have been executed successfully.
|
|
* @retval <0 On of the hook functions signalized, that the processing should be aborted; message should be skipped.
|
|
*/
|
|
int path_run_hooks(struct path *p, int when, struct sample *smps[], size_t cnt);
|
|
|
|
/** @} */ |