mirror of
https://git.rwth-aachen.de/acs/public/villas/node/
synced 2025-03-23 00:00:01 +01:00
Steffen Vogel
183b5e158a
git-svn-id: https://zerberus.eonerc.rwth-aachen.de:8443/svn/s2ss/trunk@176 8ec27952-4edc-4aab-86aa-e87bb2611832
76 lines
1.7 KiB
C
76 lines
1.7 KiB
C
/** Message related functions
|
|
*
|
|
* @author Steffen Vogel <stvogel@eonerc.rwth-aachen.de>
|
|
* @copyright 2014, Institute for Automation of Complex Power Systems, EONERC
|
|
* @file
|
|
*/
|
|
|
|
#ifndef _MSG_H_
|
|
#define _MSG_H_
|
|
|
|
#include <stdio.h>
|
|
|
|
#include "msg_format.h"
|
|
|
|
struct node;
|
|
|
|
/** Swap a message to host byte order.
|
|
*
|
|
* Message can either be transmitted in little or big endian
|
|
* format. The actual endianess for a message is defined by the
|
|
* msg::byteorder field.
|
|
* Received message are usally converted to the endianess of the host.
|
|
* This is required for further sanity checks of the sequence number
|
|
* or parsing of the data.
|
|
*
|
|
* @param m A pointer to the message
|
|
*/
|
|
void msg_swap(struct msg *m);
|
|
|
|
/** Print a raw UDP message in human readable form.
|
|
*
|
|
* @param f The file stream
|
|
* @param m A pointer to the message
|
|
* @return
|
|
* - 0 on success
|
|
* - otherwise an error occured
|
|
*/
|
|
int msg_fprint(FILE *f, struct msg *m);
|
|
|
|
/** Read a message from a file stream.
|
|
*
|
|
* @param f The file stream
|
|
* @param m A pointer to the message
|
|
* @return
|
|
* - 0 on success
|
|
* - otherwise an error occured
|
|
*/
|
|
int msg_fscan(FILE *f, struct msg *m);
|
|
|
|
/** Change the values of an existing message in a random fashion.
|
|
*
|
|
* @param m A pointer to the message whose values will be updated
|
|
*/
|
|
void msg_random(struct msg *m);
|
|
|
|
/** Send a message to a node.
|
|
*
|
|
* @param m A pointer to the message
|
|
* @param n A pointer to the node
|
|
* @return
|
|
* - 0 on success
|
|
* - otherwise an error occured
|
|
*/
|
|
int msg_send(struct msg *m, struct node *n);
|
|
|
|
/** Receive a message from a node.
|
|
*
|
|
* @param m A pointer to the message
|
|
* @param n A pointer to the node
|
|
* @return
|
|
* - 0 on success
|
|
* - otherwise an error occured
|
|
*/
|
|
int msg_recv(struct msg *m, struct node *n);
|
|
|
|
#endif /* _MSG_H_ */
|