2017-09-04 16:19:27 +02:00
|
|
|
/* Message related functions.
|
|
|
|
*
|
2022-03-15 09:18:01 -04:00
|
|
|
* Author: Steffen Vogel <post@steffenvogel.de>
|
2022-03-15 09:28:57 -04:00
|
|
|
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
|
2022-07-04 18:20:03 +02:00
|
|
|
* SPDX-License-Identifier: Apache-2.0
|
2017-09-04 16:19:27 +02:00
|
|
|
*/
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
2023-09-07 11:46:39 +02:00
|
|
|
#include <villas/signal_list.hpp>
|
2021-08-10 10:12:48 -04:00
|
|
|
|
|
|
|
namespace villas {
|
|
|
|
|
|
|
|
// Forward declarataions
|
|
|
|
struct List;
|
|
|
|
|
|
|
|
namespace node {
|
|
|
|
|
2017-09-04 16:19:27 +02:00
|
|
|
// Forward declarations
|
2021-08-10 10:12:48 -04:00
|
|
|
struct Message;
|
|
|
|
struct Sample;
|
2017-09-04 16:19:27 +02:00
|
|
|
|
|
|
|
// Convert msg from network to host byteorder
|
2021-08-10 10:12:48 -04:00
|
|
|
void msg_ntoh(struct Message *m);
|
2017-09-04 16:19:27 +02:00
|
|
|
|
|
|
|
// Convert msg from host to network byteorder
|
2021-08-10 10:12:48 -04:00
|
|
|
void msg_hton(struct Message *m);
|
2017-09-04 16:19:27 +02:00
|
|
|
|
|
|
|
// Convert msg header from network to host byteorder
|
2021-08-10 10:12:48 -04:00
|
|
|
void msg_hdr_hton(struct Message *m);
|
2017-09-04 16:19:27 +02:00
|
|
|
|
|
|
|
// Convert msg header from host to network byteorder
|
2021-08-10 10:12:48 -04:00
|
|
|
void msg_hdr_ntoh(struct Message *m);
|
2017-09-04 16:19:27 +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.
|
|
|
|
*/
|
2021-08-10 10:12:48 -04:00
|
|
|
int msg_verify(const struct Message *m);
|
2017-09-04 16:19:27 +02:00
|
|
|
|
|
|
|
// Copy fields from \p msg into \p smp.
|
2023-09-07 11:46:39 +02:00
|
|
|
int msg_to_sample(const struct Message *msg, struct Sample *smp,
|
|
|
|
const SignalList::Ptr sigs, uint8_t *source_index);
|
2017-09-04 16:19:27 +02:00
|
|
|
|
|
|
|
// Copy fields form \p smp into \p msg.
|
2023-09-07 11:46:39 +02:00
|
|
|
int msg_from_sample(struct Message *msg, const struct Sample *smp,
|
|
|
|
const SignalList::Ptr sigs, uint8_t source_index);
|
2021-08-10 10:12:48 -04:00
|
|
|
|
2023-08-28 09:34:02 +02:00
|
|
|
} // namespace node
|
|
|
|
} // namespace villas
|