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/nodes/shmem.h
Steffen Vogel 86bddfa83a shmem: whitespace cleanup
I like a bit more whitespace for readability
2017-06-15 15:07:42 +02:00

68 lines
2.1 KiB
C

/** Node-type for shared memory communication.
*
* @file
* @author Georg Martin Reinke <georg.reinke@rwth-aachen.de>
* @copyright 2017, 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 <http://www.gnu.org/licenses/>.
*********************************************************************************/
/**
* @ingroup node
* @addtogroup shmem_node Shared memory node type
* @{
*/
#pragma once
#include "node.h"
#include "memory.h"
#include "pool.h"
#include "queue.h"
#include "config.h"
#include "shmem.h"
/** Node-type for shared memory communication.
* @see node_type
*/
struct shmem {
const char* out_name; /**< Name of the shm object for the output queue. */
const char* in_name; /**< Name of the shm object for the input queue. */
struct shmem_conf conf; /**< Interface configuration struct. */
char **exec; /**< External program to execute on start. */
struct shmem_int intf; /**< Shmem interface */
};
/** @see node_type::print */
char * shmem_print(struct node *n);
/** @see node_type::parse */
int shmem_parse(struct node *n, config_setting_t *cfg);
/** @see node_type::open */
int shmem_open(struct node *n);
/** @see node_type::close */
int shmem_close(struct node *n);
/** @see node_type::read */
int shmem_read(struct node *n, struct sample *smps[], unsigned cnt);
/** @see node_type::write */
int shmem_write(struct node *n, struct sample *smps[], unsigned cnt);
/** @} */