1
0
Fork 0
mirror of https://git.rwth-aachen.de/acs/public/villas/node/ synced 2025-03-09 00:00:00 +01:00
VILLASnode/include/villas/formats/msg.hpp

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

55 lines
1.4 KiB
C++
Raw Permalink Normal View History

/* Message related functions.
2017-09-04 16:19:27 +02:00
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
2017-09-04 16:19:27 +02:00
#pragma once
#include <villas/signal_list.hpp>
namespace villas {
// Forward declarataions
struct List;
namespace node {
// Forward declarations
struct Message;
struct Sample;
2017-09-04 16:19:27 +02:00
// Convert msg from network to host byteorder
void msg_ntoh(struct Message *m);
2017-09-04 16:19:27 +02:00
// Convert msg from host to network byteorder
void msg_hton(struct Message *m);
2017-09-04 16:19:27 +02:00
// Convert msg header from network to host byteorder
void msg_hdr_hton(struct Message *m);
2017-09-04 16:19:27 +02:00
// Convert msg header from host to network byteorder
void msg_hdr_ntoh(struct Message *m);
2017-09-04 16:19:27 +02:00
/* Check the consistency of a message.
2017-09-04 16:19:27 +02:00
*
* 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(const struct Message *m);
2017-09-04 16:19:27 +02:00
// Copy fields from \p msg into \p smp.
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.
int msg_from_sample(struct Message *msg, const struct Sample *smp,
const SignalList::Ptr sigs, uint8_t source_index);
} // namespace node
} // namespace villas