2017-04-24 13:22:55 +02:00
|
|
|
/** Message related functions
|
|
|
|
*
|
|
|
|
* @file
|
|
|
|
* @author Steffen Vogel <stvogel@eonerc.rwth-aachen.de>
|
|
|
|
* @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/>.
|
2017-04-24 13:22:55 +02:00
|
|
|
*********************************************************************************/
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
|
|
|
/* Forward declarations. */
|
|
|
|
struct webmsg;
|
|
|
|
|
|
|
|
/** Swaps the byte-order of the message.
|
|
|
|
*
|
|
|
|
* Message are always transmitted in network (big endian) byte order.
|
|
|
|
*
|
|
|
|
* @param m A pointer to the message
|
|
|
|
*/
|
|
|
|
void webmsg_hdr_ntoh(struct webmsg *m);
|
|
|
|
|
|
|
|
void webmsg_hdr_hton(struct webmsg *m);
|
|
|
|
|
|
|
|
void webmsg_ntoh(struct webmsg *m);
|
|
|
|
|
|
|
|
void webmsg_hton(struct webmsg *m);
|
|
|
|
|
|
|
|
/** 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.
|
|
|
|
*/
|
|
|
|
int msg_verify(struct webmsg *m);
|