log_cbor.h File Reference

Detailed Description

CBOR-encoded network logging.

This file defines a log-to-network system, where each Log message is encoded using CBOR (IETF-RFC-8949). Variations using raw-Ethernet and UDP are provided. Both default to broadcast mode, but can be changed to unicast by calling the connect(...) method.

For more information on the logging system:

See also

log.h

The encoding used here is compatible with the "Diagnostic Logging" message defined in the "Slingshot Payload Manual" (ATR-2022-01270). This manual is included in this repo under "/examples/slingshot".

For the simpler encoding used in example designs, see "eth_chat.h". (Especially eth::LogToChat, which implements the same logging API.)

Definition in file log_cbor.h.

#include <satcat5/ethernet.h>
#include <satcat5/log.h>
#include <satcat5/types.h>
#include <satcat5/udp_core.h>

Include dependency graph for log_cbor.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	satcat5::log::FromCbor
	Read CBOR-formatted network messages and copy to the local log. More...
class	satcat5::log::ToCbor
	Write local logs to a CBOR-formatted network message. More...
class	satcat5::eth::LogFromCbor
	Specialization of satcat5::log::FromCbor for raw-Ethernet frames. More...
class	satcat5::eth::LogToCbor
	Specialization of satcat5::log::ToCbor for raw-Ethernet frames. More...
class	satcat5::udp::LogFromCbor
	Specialization of satcat5::log::FromCbor for UDP datagrams. More...
class	satcat5::udp::LogToCbor
	Specialization of satcat5::log::ToCbor for UDP datagrams. More...