MagAOX::logger::flatbuffer_log Struct Reference

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

#include <flatbuffer_log.hpp>

Inheritance diagram for MagAOX::logger::flatbuffer_log:

Collaboration diagram for MagAOX::logger::flatbuffer_log:

Static Public Member Functions
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)

Detailed Description

Base class for logs consisting of a flatbuffer message.

Such logs are used to log arbitrary data structures using the flatbuffer protocol. Does not have eventCode or defaultLevel, so this can not be used as a log type directly.

Definition at line 41 of file flatbuffer_log.hpp.

Member Function Documentation

format()

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

inlinestatic

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 )

inlinestatic

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  )

inlinestatic

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.

---

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

• libMagAOX/logger/types/flatbuffer_log.hpp