MagAOX::logger::user_log Struct Reference

User entered log, a string-type log. More...

#include <user_log.hpp>

Inheritance diagram for MagAOX::logger::user_log:

Collaboration diagram for MagAOX::logger::user_log:

Static Public Member Functions
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 Public Attributes
static const flatlogs::eventCodeT	eventCode = eventCodes::USER_LOG
	The event code. More...
static const flatlogs::logPrioT	defaultLevel = flatlogs::logPrio::LOG_INFO
	The default level. More...

Detailed Description

User entered log, a string-type log.

Definition at line 23 of file user_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

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

Definition at line 47 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

msg	the fbMessage type holding a FlatBufferBuilder

Definition at line 39 of file flatbuffer_log.hpp.

msgString()

static std::string MagAOX::logger::user_log::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 32 of file user_log.hpp.

Member Data Documentation

defaultLevel

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

static

The default level.

Definition at line 29 of file user_log.hpp.

eventCode

const flatlogs::eventCodeT MagAOX::logger::user_log::eventCode = eventCodes::USER_LOG

static

The event code.

Definition at line 26 of file user_log.hpp.

---

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

• /home/jrmales/Source/MagAOX/libMagAOX/logger/types/user_log.hpp