mirror of
https://git.rwth-aachen.de/acs/public/villas/node/
synced 2025-03-09 00:00:00 +01:00
fixed documentation of node-types
This commit is contained in:
parent
98eabc7581
commit
bd1fa43d1f
7 changed files with 53 additions and 48 deletions
|
|
@ -27,12 +27,12 @@ enum {
|
|||
|
||||
struct file {
|
||||
struct file_direction {
|
||||
AFILE *handle; /**< libc: stdio file handle */
|
||||
AFILE *handle; /**< libc: stdio file handle. */
|
||||
|
||||
const char *mode; /**< libc: fopen() mode */
|
||||
const char *mode; /**< libc: fopen() mode. */
|
||||
const char *fmt; /**< Format string for file name. */
|
||||
|
||||
char *uri; /**< Real file name */
|
||||
char *uri; /**< Real file name. */
|
||||
} read, write;
|
||||
|
||||
int rewind; /**< Should we rewind the file when we reach EOF? */
|
||||
|
|
@ -53,22 +53,22 @@ struct file {
|
|||
double read_rate; /**< The read rate. */
|
||||
};
|
||||
|
||||
/** @see node_vtable::print */
|
||||
/** @see node_type::print */
|
||||
char * file_print(struct node *n);
|
||||
|
||||
/** @see node_vtable::parse */
|
||||
/** @see node_type::parse */
|
||||
int file_parse(struct node *n, config_setting_t *cfg);
|
||||
|
||||
/** @see node_vtable::open */
|
||||
/** @see node_type::open */
|
||||
int file_start(struct node *n);
|
||||
|
||||
/** @see node_vtable::close */
|
||||
/** @see node_type::close */
|
||||
int file_stop(struct node *n);
|
||||
|
||||
/** @see node_vtable::read */
|
||||
/** @see node_type::read */
|
||||
int file_read(struct node *n, struct sample *smps[], unsigned cnt);
|
||||
|
||||
/** @see node_vtable::write */
|
||||
/** @see node_type::write */
|
||||
int file_write(struct node *n, struct sample *smps[], unsigned cnt);
|
||||
|
||||
/** @} */
|
||||
|
|
|
|||
|
|
@ -40,27 +40,27 @@ struct fpga {
|
|||
/** @see node_vtable::init */
|
||||
int fpga_init(struct super_node *sn);
|
||||
|
||||
/** @see node_vtable::deinit */
|
||||
/** @see node_type::deinit */
|
||||
int fpga_deinit();
|
||||
|
||||
/** @see node_vtable::parse */
|
||||
/** @see node_type::parse */
|
||||
int fpga_parse(struct node *n, config_setting_t *cfg);
|
||||
|
||||
struct fpga_card * fpga_lookup_card(const char *name);
|
||||
|
||||
/** @see node_vtable::print */
|
||||
/** @see node_type::print */
|
||||
char * fpga_print(struct node *n);
|
||||
|
||||
/** @see node_vtable::open */
|
||||
/** @see node_type::open */
|
||||
int fpga_start(struct node *n);
|
||||
|
||||
/** @see node_vtable::close */
|
||||
/** @see node_type::close */
|
||||
int fpga_stop(struct node *n);
|
||||
|
||||
/** @see node_vtable::read */
|
||||
/** @see node_type::read */
|
||||
int fpga_read(struct node *n, struct sample *smps[], unsigned cnt);
|
||||
|
||||
/** @see node_vtable::write */
|
||||
/** @see node_type::write */
|
||||
int fpga_write(struct node *n, struct sample *smps[], unsigned cnt);
|
||||
|
||||
/** Get pointer to internal VILLASfpga datastructure */
|
||||
|
|
|
|||
|
|
@ -50,32 +50,32 @@ struct ngsi {
|
|||
|
||||
/** Initialize global NGSI settings and maps shared memory regions.
|
||||
*
|
||||
* @see node_vtable::init
|
||||
* @see node_type::init
|
||||
*/
|
||||
int ngsi_init(struct super_node *sn);
|
||||
|
||||
/** Free global NGSI settings and unmaps shared memory regions.
|
||||
*
|
||||
* @see node_vtable::deinit
|
||||
* @see node_type::deinit
|
||||
*/
|
||||
int ngsi_deinit();
|
||||
|
||||
/** @see node_vtable::parse */
|
||||
/** @see node_type::parse */
|
||||
int ngsi_parse(struct node *n, config_setting_t *cfg);
|
||||
|
||||
/** @see node_vtable::print */
|
||||
/** @see node_type::print */
|
||||
char * ngsi_print(struct node *n);
|
||||
|
||||
/** @see node_vtable::open */
|
||||
/** @see node_type::open */
|
||||
int ngsi_start(struct node *n);
|
||||
|
||||
/** @see node_vtable::close */
|
||||
/** @see node_type::close */
|
||||
int ngsi_stop(struct node *n);
|
||||
|
||||
/** @see node_vtable::read */
|
||||
/** @see node_type::read */
|
||||
int ngsi_read(struct node *n, struct sample *smps[], unsigned cnt);
|
||||
|
||||
/** @see node_vtable::write */
|
||||
/** @see node_type::write */
|
||||
int ngsi_write(struct node *n, struct sample *smps[], unsigned cnt);
|
||||
|
||||
/** @} */
|
||||
|
|
@ -40,35 +40,35 @@ struct opal {
|
|||
|
||||
/** Initialize global OPAL settings and maps shared memory regions.
|
||||
*
|
||||
* @see node_vtable::init
|
||||
* @see node_type::init
|
||||
*/
|
||||
int opal_init(struct super_node *sn);
|
||||
|
||||
/** Free global OPAL settings and unmaps shared memory regions.
|
||||
*
|
||||
* @see node_vtable::deinit
|
||||
* @see node_type::deinit
|
||||
*/
|
||||
int opal_deinit();
|
||||
|
||||
/** @see node_vtable::parse */
|
||||
/** @see node_type::parse */
|
||||
int opal_parse(struct node *n, config_setting_t *cfg);
|
||||
|
||||
/** @see node_vtable::print */
|
||||
/** @see node_type::print */
|
||||
char * opal_print(struct node *n);
|
||||
|
||||
/** Print global settings of the OPAL node type. */
|
||||
int opal_print_global();
|
||||
|
||||
/** @see node_vtable::open */
|
||||
/** @see node_type::open */
|
||||
int opal_start(struct node *n);
|
||||
|
||||
/** @see node_vtable::close */
|
||||
/** @see node_type::close */
|
||||
int opal_stop(struct node *n);
|
||||
|
||||
/** @see node_vtable::read */
|
||||
/** @see node_type::read */
|
||||
int opal_read(struct node *n, struct sample *smps[], unsigned cnt);
|
||||
|
||||
/** @see node_vtable::write */
|
||||
/** @see node_type::write */
|
||||
int opal_write(struct node *n, struct sample *smps[], unsigned cnt);
|
||||
|
||||
/** @} */
|
||||
|
|
@ -38,16 +38,22 @@ struct shmem {
|
|||
struct shmem_shared *shared; /**< Shared datastructure. */
|
||||
};
|
||||
|
||||
char *shmem_print(struct node *n);
|
||||
/** @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);
|
||||
|
||||
/** @} */
|
||||
|
|
|
|||
|
|
@ -60,25 +60,25 @@ struct socket {
|
|||
/** @see node_vtable::init */
|
||||
int socket_init(struct super_node *sn);
|
||||
|
||||
/** @see node_vtable::deinit */
|
||||
/** @see node_type::deinit */
|
||||
int socket_deinit();
|
||||
|
||||
/** @see node_vtable::open */
|
||||
/** @see node_type::open */
|
||||
int socket_start(struct node *n);
|
||||
|
||||
/** @see node_vtable::close */
|
||||
/** @see node_type::close */
|
||||
int socket_stop(struct node *n);
|
||||
|
||||
/** @see node_vtable::write */
|
||||
/** @see node_type::write */
|
||||
int socket_write(struct node *n, struct sample *smps[], unsigned cnt);
|
||||
|
||||
/** @see node_vtable::read */
|
||||
/** @see node_type::read */
|
||||
int socket_read(struct node *n, struct sample *smps[], unsigned cnt);
|
||||
|
||||
/** @see node_vtable::parse */
|
||||
/** @see node_type::parse */
|
||||
int socket_parse(struct node *n, config_setting_t *cfg);
|
||||
|
||||
/** @see node_vtable::print */
|
||||
/** @see node_type::print */
|
||||
char * socket_print(struct node *n);
|
||||
|
||||
/** Generate printable socket address depending on the address family
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ struct websocket {
|
|||
struct list destinations; /**< List of websocket servers connect to in client mode (struct websocket_destination). */
|
||||
|
||||
struct pool pool;
|
||||
struct queue_signalled queue; /**< For samples which are received from WebSockets */
|
||||
struct queue_signalled queue; /**< For samples which are received from WebSockets */
|
||||
};
|
||||
|
||||
/* Internal datastructures */
|
||||
|
|
@ -56,7 +56,6 @@ struct websocket_connection {
|
|||
char *_name;
|
||||
};
|
||||
|
||||
/* Internal datastructures */
|
||||
struct websocket_destination {
|
||||
char *uri;
|
||||
struct lws_client_connect_info info;
|
||||
|
|
@ -67,22 +66,22 @@ int websocket_protocol_cb(struct lws *wsi, enum lws_callback_reasons reason, voi
|
|||
/** @see node_vtable::init */
|
||||
int websocket_init(struct super_node *sn);
|
||||
|
||||
/** @see node_vtable::deinit */
|
||||
/** @see node_type::deinit */
|
||||
int websocket_deinit();
|
||||
|
||||
/** @see node_vtable::open */
|
||||
/** @see node_type::open */
|
||||
int websocket_start(struct node *n);
|
||||
|
||||
/** @see node_vtable::close */
|
||||
/** @see node_type::close */
|
||||
int websocket_stop(struct node *n);
|
||||
|
||||
/** @see node_vtable::close */
|
||||
/** @see node_type::close */
|
||||
int websocket_destroy(struct node *n);
|
||||
|
||||
/** @see node_vtable::read */
|
||||
/** @see node_type::read */
|
||||
int websocket_read(struct node *n, struct sample *smps[], unsigned cnt);
|
||||
|
||||
/** @see node_vtable::write */
|
||||
/** @see node_type::write */
|
||||
int websocket_write(struct node *n, struct sample *smps[], unsigned cnt);
|
||||
|
||||
/** @} */
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue