MagAOX::logger::string_log Struct Reference

Base class for logs consisting of a string message. More...

#include <string_log.hpp>

Inheritance diagram for MagAOX::logger::string_log:

Collaboration diagram for MagAOX::logger::string_log:

Classes
struct	messageT
	The type of the 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 formatted for human consumption.
static std::string	message (void *msgBuffer)
	Access the message field.
static logMetaDetail	getAccessor (const std::string &member)
	Get the logMetaDetail for a member by name.
static flatlogs::msgLenT	length (const fbMessage &msg)
	Get the length of the message.
static int	format (void *msgBuffer, const fbMessage &msg)
	Format the buffer given the input message.
static std::string	msgJSON (void *msgBuffer, flatlogs::msgLenT len, const uint8_t *binarySchema, const unsigned int binarySchemaLength)

Detailed Description

Base class for logs consisting of a string message.

Does not have eventCode or defaultLevel, so this can not be used as a log type in logger.

Definition at line 27 of file string_log.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 54 of file flatbuffer_log.hpp.

getAccessor()

static logMetaDetail MagAOX::logger::string_log::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 logMetaDetail if member not recognized

Parameters

[in]

member

the name of the member

Definition at line 92 of file string_log.hpp.

References message(), MagAOX::logger::logMeta::State, and MagAOX::logger::logMeta::String.

Referenced by libXWCTest::loggerTest::logTypeAccessorTest::TEST_CASE().

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 46 of file flatbuffer_log.hpp.

message()

static std::string MagAOX::logger::string_log::message ( void *  msgBuffer )

inlinestatic

Access the message field.

Parameters

[in]

msgBuffer

Buffer containing the flatbuffer serialized message.

Definition at line 74 of file string_log.hpp.

References MagAOX::logger::GetString_log_fb().

Referenced by getAccessor(), and MagAOX::logger::text_log::getAccessor().

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 65 of file flatbuffer_log.hpp.

msgString()

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

inlinestatic

Get the message formatted for human consumption.

Parameters

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

Definition at line 59 of file string_log.hpp.

References MagAOX::logger::GetString_log_fb().

verify()

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

References flatlogs::logHeader::messageBuffer(), and MagAOX::logger::VerifyString_log_fbBuffer().

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

---

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

• libMagAOX/logger/types/string_log.hpp