API
MagAOX::logger::empty_log< derivedT > Struct Template Reference

Base class for logs consisting of an empty message. More...

#include <empty_log.hpp>

Collaboration diagram for MagAOX::logger::empty_log< derivedT >:
Collaboration graph

Public Types

typedef emptyMessage messageT
 The type of the message. More...
 

Static Public Member Functions

static flatlogs::msgLenT length (const messageT &msg)
 Get the length of the message. More...
 
static int format (void *msgBuffer, const messageT &msg)
 Format the buffer given a message – a no-op since the message is an emptyMessage. More...
 
static int extract (messageT &msg, void *msgBuffer, flatlogs::msgLenT len)
 Extract the message from a buffer – a no-op since it is an emptyMessage. More...
 
static bool verify (flatlogs::bufferPtrT &logBuff, flatlogs::msgLenT len)
 
static std::string msgString (void *msgBuffer, flatlogs::msgLenT len)
 
static std::string msgJSON (void *msgBuffer, flatlogs::msgLenT len, const uint8_t *binarySchema, const unsigned int binarySchemaLength)
 

Detailed Description

template<class derivedT>
struct MagAOX::logger::empty_log< derivedT >

Base class for logs consisting of an empty message.

Such logs are used to log events. Does not have eventCode or defaultLevel, so this can not be used as a log type directly.

Definition at line 37 of file empty_log.hpp.

Member Typedef Documentation

◆ messageT

template<class derivedT >
typedef emptyMessage MagAOX::logger::empty_log< derivedT >::messageT

The type of the message.

Definition at line 40 of file empty_log.hpp.

Member Function Documentation

◆ extract()

template<class derivedT >
static int MagAOX::logger::empty_log< derivedT >::extract ( messageT msg,
void *  msgBuffer,
flatlogs::msgLenT  len 
)
inlinestatic

Extract the message from a buffer – a no-op since it is an emptyMessage.

Returns
0
Parameters
[out]msgan emptyMessage to which nothing is done.
[in]msgBufferthe empty buffer. Is ignored.
[in]lenignored length of the empty buffer.

Definition at line 68 of file empty_log.hpp.

◆ format()

template<class derivedT >
static int MagAOX::logger::empty_log< derivedT >::format ( void *  msgBuffer,
const messageT msg 
)
inlinestatic

Format the buffer given a message – a no-op since the message is an emptyMessage.

Returns
0
Parameters
[out]msgBufferthe buffer, which is ignored.
[in]msgan emptyMessage.

Definition at line 54 of file empty_log.hpp.

◆ length()

template<class derivedT >
static flatlogs::msgLenT MagAOX::logger::empty_log< derivedT >::length ( const messageT msg)
inlinestatic

Get the length of the message.

Definition at line 43 of file empty_log.hpp.

◆ msgJSON()

template<class derivedT >
static std::string MagAOX::logger::empty_log< derivedT >::msgJSON ( void *  msgBuffer,
flatlogs::msgLenT  len,
const uint8_t *  binarySchema,
const unsigned int  binarySchemaLength 
)
inlinestatic
Parameters
[in]msgBufferBuffer containing the flatbuffer serialized message.
[in]len[unused] length of msgBuffer.
[in]binarySchema[unused]
[in]binarySchemaLength[unused]

Definition at line 97 of file empty_log.hpp.

◆ msgString()

template<class derivedT >
static std::string MagAOX::logger::empty_log< derivedT >::msgString ( void *  msgBuffer,
flatlogs::msgLenT  len 
)
inlinestatic

Definition at line 89 of file empty_log.hpp.

◆ verify()

template<class derivedT >
static bool MagAOX::logger::empty_log< derivedT >::verify ( flatlogs::bufferPtrT logBuff,
flatlogs::msgLenT  len 
)
inlinestatic
Parameters
[in]logBuffBuffer containing the flatbuffer serialized message.
[in]lenlength of msgBuffer.

Definition at line 81 of file empty_log.hpp.


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