MagAOX::logger::observer Struct Reference

Log entry recording the observer. More...

#include <observer.hpp>

Inheritance diagram for MagAOX::logger::observer:

Collaboration diagram for MagAOX::logger::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 formatte for human consumption. 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::OBSERVER
	The event code. More...
static const flatlogs::logPrioT	defaultLevel = flatlogs::logPrio::LOG_INFO
	The default level. More...
static timespec	lastRecord
	The time of the last time this log was recorded. Used by the telemetry system. More...

Detailed Description

Log entry recording the observer.

Definition at line 27 of file observer.hpp.

Member Function Documentation

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.

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::observer::msgString ( void *  msgBuffer, flatlogs::msgLenT  len  )

inlinestatic

Get the message formatte for human consumption.

Parameters

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

Definition at line 67 of file observer.hpp.

verify()

static bool MagAOX::logger::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 58 of file observer.hpp.

Member Data Documentation

defaultLevel

const flatlogs::logPrioT MagAOX::logger::observer::defaultLevel = flatlogs::logPrio::LOG_INFO

static

The default level.

Definition at line 33 of file observer.hpp.

eventCode

const flatlogs::eventCodeT MagAOX::logger::observer::eventCode = eventCodes::OBSERVER

static

The event code.

Definition at line 30 of file observer.hpp.

lastRecord

timespec MagAOX::logger::observer::lastRecord

static

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

Definition at line 35 of file observer.hpp.

---

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

• libMagAOX/logger/types/observer.hpp