Log entry recording the build-time git state. More...

#include <telem_observer.hpp>

Inheritance diagram for MagAOX::logger::telem_observer:

Collaboration diagram for MagAOX::logger::telem_observer:

Classes
struct	messageT
	The type of the input message. More...

Static Public Member Functions
static bool	verify (flatlogs::bufferPtrT &logBuff, flatlogs::msgLenT len)

static std::string	msgString (void *msgBuffer, flatlogs::msgLenT len)
	Get the message formattd for human consumption. More...

static std::string	email (void *msgBuffer)

static std::string	obsName (void *msgBuffer)

static bool	observing (void *msgBuffer)

static logMetaDetail	getAccessor (const std::string &member)
	Get the logMetaDetail for a member by name. More...

static flatlogs::msgLenT	length (const fbMessage &msg)
	Get the length of the message. More...

static int	format (void *msgBuffer, const fbMessage &msg)
	Format the buffer given the input message. More...

static std::string	msgJSON (void msgBuffer, flatlogs::msgLenT len, const uint8_t binarySchema, const unsigned int binarySchemaLength)

Static Public Attributes
static const flatlogs::eventCodeT	eventCode = eventCodes::TELEM_OBSERVER
	The event code. More...

static const flatlogs::logPrioT	defaultLevel = flatlogs::logPrio::LOG_TELEM
	The default level. More...

static timespec	lastRecord = {0,0}
	The time of the last time this log was recorded. Used by the telemetry system. More...

Detailed Description

Log entry recording the build-time git state.

Definition at line 27 of file telem_observer.hpp.

Member Function Documentation

◆ email()

static std::string MagAOX::logger::telem_observer::email ( void * msgBuffer )

inlinestatic

Definition at line 125 of file telem_observer.hpp.

Referenced by MagAOX::logger::telem_observer::messageT::messageT(), getAccessor(), and verify().

◆ format()

static int MagAOX::logger::flatbuffer_log::format	(	void *	msgBuffer,
		const fbMessage &	msg
	)

inlinestaticinherited

Format the buffer given the input message.

Todo:: this is an unneccesary memcpy from the FlatBufferBuilder, we need to figure out how to not do this.

Parameters

[out]	msgBuffer	the buffer, must be pre-allocated to size length(msg)
[in]	msg	the message which contains a flatbuffer builder, from which the data are memcpy-ed.

Definition at line 53 of file flatbuffer_log.hpp.

◆ getAccessor()

static logMetaDetail MagAOX::logger::telem_observer::getAccessor ( const std::string & member )

inlinestatic

Get the logMetaDetail for a member by name.

Returns: the a logMetaDetail filled in with the appropriate details; an empty logmegaDetail if member not recognized

Parameters

[in] member the name of the member

Definition at line 156 of file telem_observer.hpp.

Referenced by MagAOX::logger::logMemberAccessor().

◆ length()

static flatlogs::msgLenT MagAOX::logger::flatbuffer_log::length ( const fbMessage & msg )

inlinestaticinherited

Get the length of the message.

Parameters

[in] msg the fbMessage type holding a FlatBufferBuilder

Definition at line 45 of file flatbuffer_log.hpp.

◆ msgJSON()

static std::string MagAOX::logger::flatbuffer_log::msgJSON	(	void *	msgBuffer,
		flatlogs::msgLenT	len,
		const uint8_t *	binarySchema,
		const unsigned int	binarySchemaLength
	)

inlinestaticinherited

Parameters

[in]	msgBuffer	Buffer containing the flatbuffer serialized message.
[in]	len	[unused] length of msgBuffer.
[in]	binarySchema	flatbuffers binary schema for this log type
[in]	binarySchemaLength	flatbuffers binary schema length

Definition at line 64 of file flatbuffer_log.hpp.

◆ msgString()

static std::string MagAOX::logger::telem_observer::msgString	(	void *	msgBuffer,
		flatlogs::msgLenT	len
	)

inlinestatic

Get the message formattd for human consumption.

Parameters

[in]	msgBuffer	Buffer containing the flatbuffer serialized message.
[in]	len	[unused] length of msgBuffer.

Definition at line 95 of file telem_observer.hpp.

◆ observing()

static bool MagAOX::logger::telem_observer::observing ( void * msgBuffer )

inlinestatic

Definition at line 145 of file telem_observer.hpp.

Referenced by MagAOX::logger::telem_observer::messageT::messageT(), and getAccessor().

◆ obsName()

static std::string MagAOX::logger::telem_observer::obsName ( void * msgBuffer )

inlinestatic

Definition at line 135 of file telem_observer.hpp.

Referenced by MagAOX::logger::telem_observer::messageT::messageT(), and getAccessor().

◆ verify()

static bool MagAOX::logger::telem_observer::verify	(	flatlogs::bufferPtrT &	logBuff,
		flatlogs::msgLenT	len
	)

inlinestatic

Parameters

[in]	logBuff	Buffer containing the flatbuffer serialized message.
[in]	len	length of msgBuffer.

Definition at line 56 of file telem_observer.hpp.

Member Data Documentation

◆ defaultLevel

const flatlogs::logPrioT MagAOX::logger::telem_observer::defaultLevel = flatlogs::logPrio::LOG_TELEM

static

The default level.

Definition at line 33 of file telem_observer.hpp.

◆ eventCode

const flatlogs::eventCodeT MagAOX::logger::telem_observer::eventCode = eventCodes::TELEM_OBSERVER

static

The event code.

Definition at line 30 of file telem_observer.hpp.

Referenced by MagAOX::logger::logMemberAccessor().

◆ lastRecord

timespec MagAOX::logger::telem_observer::lastRecord = {0,0}

static

The time of the last time this log was recorded. Used by the telemetry system.

Definition at line 35 of file telem_observer.hpp.

The documentation for this struct was generated from the following files:

libMagAOX/logger/types/telem_observer.hpp
libMagAOX/logger/types/telem.cpp

Classes

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ email()

◆ format()

◆ getAccessor()

◆ length()

◆ msgJSON()

◆ msgString()

◆ observing()

◆ obsName()

◆ verify()

Member Data Documentation

◆ defaultLevel

◆ eventCode

◆ lastRecord