2014-07-07 07:53:42 +00:00
|
|
|
/** Message related functions
|
2014-06-05 09:34:29 +00:00
|
|
|
*
|
2014-06-28 06:40:52 +00:00
|
|
|
* @file
|
2015-06-02 21:53:04 +02:00
|
|
|
* @author Steffen Vogel <stvogel@eonerc.rwth-aachen.de>
|
2017-03-03 20:20:13 -04:00
|
|
|
* @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-05-05 19:24:16 +00:00
|
|
|
*
|
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-05-05 19:24:16 +00:00
|
|
|
*
|
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-06-02 21:53:04 +02:00
|
|
|
*********************************************************************************/
|
2014-06-05 09:34:29 +00:00
|
|
|
|
2017-02-16 09:04:12 -03:00
|
|
|
#pragma once
|
2014-06-05 09:34:29 +00:00
|
|
|
|
2017-04-23 22:12:10 +02:00
|
|
|
/* Forward declarations. */
|
|
|
|
struct msg;
|
2017-05-23 09:33:42 +02:00
|
|
|
struct sample;
|
2014-06-05 09:34:29 +00:00
|
|
|
|
2017-05-23 13:55:13 +02:00
|
|
|
/** The maximum length of a packet which contains stuct msg. */
|
|
|
|
#define MSG_MAX_PACKET_LEN 1500
|
|
|
|
|
2017-04-23 22:12:10 +02:00
|
|
|
/** Swaps the byte-order of the message.
|
2014-07-18 16:05:49 +00:00
|
|
|
*
|
2017-04-23 22:12:10 +02:00
|
|
|
* Message are always transmitted in network (big endian) byte order.
|
2014-07-18 16:05:49 +00:00
|
|
|
*
|
|
|
|
* @param m A pointer to the message
|
|
|
|
*/
|
2017-04-23 22:12:10 +02:00
|
|
|
void msg_hdr_ntoh(struct msg *m);
|
|
|
|
|
|
|
|
void msg_hdr_hton(struct msg *m);
|
|
|
|
|
|
|
|
void msg_ntoh(struct msg *m);
|
|
|
|
|
|
|
|
void msg_hton(struct msg *m);
|
2014-07-18 16:05:49 +00:00
|
|
|
|
2015-04-01 13:25:03 +02:00
|
|
|
/** Check the consistency of a message.
|
|
|
|
*
|
|
|
|
* The functions checks the header fields of a message.
|
|
|
|
*
|
|
|
|
* @param m A pointer to the message
|
|
|
|
* @retval 0 The message header is valid.
|
|
|
|
* @retval <0 The message header is invalid.
|
|
|
|
*/
|
2017-05-23 09:33:42 +02:00
|
|
|
int msg_verify(struct msg *m);
|
|
|
|
|
|
|
|
/** Copy fields from \p msg into \p smp. */
|
|
|
|
int msg_to_sample(struct msg *msg, struct sample *smp);
|
|
|
|
|
|
|
|
/** Copy fields form \p smp into \p msg. */
|
|
|
|
int msg_from_sample(struct msg *msg, struct sample *smp);
|
|
|
|
|
|
|
|
|
|
|
|
/** Copy / read struct msg's from buffer \p buf to / fram samples \p smps. */
|
|
|
|
ssize_t msg_buffer_from_samples(struct sample *smps[], unsigned cnt, char *buf, size_t len);
|
|
|
|
|
|
|
|
/** Read struct sample's from buffer \p buf into samples \p smps. */
|
|
|
|
int msg_buffer_to_samples(struct sample *smps[], unsigned cnt, char *buf, size_t len);
|