Collaboration diagram for The flatlogs binary header definition:

Modules
	The log priorities

	The flatlogs timestamp

Classes
class	flatlogs::logHeader
	The log entry header. More...

Typedefs
typedef std::shared_ptr< char >	flatlogs::bufferPtrT
	The log entry buffer smart pointer. More...

Functions
static int	flatlogs::logHeader::logLevel (bufferPtrT &logBuffer, const logPrioT &lvl)
	Set the level of a log entry in a logBuffer header. More...

static logPrioT	flatlogs::logHeader::logLevel (bufferPtrT &logBuffer)
	Extract the level of a log entry. More...

static int	flatlogs::logHeader::eventCode (bufferPtrT &logBuffer, const eventCodeT &ec)
	Set the event code of a log entry. More...

static eventCodeT	flatlogs::logHeader::eventCode (bufferPtrT &logBuffer)
	Extract the event code of a log entry. More...

static timespecX	flatlogs::logHeader::timespec (bufferPtrT &logBuffer)
	Extract the timespec of a log entry. More...

static int	flatlogs::logHeader::timespec (bufferPtrT &logBuffer, const timespecX &ts)
	Set the timespec of a log entry. More...

static size_t	flatlogs::logHeader::lenSize (bufferPtrT &logBuffer)
	Get the size in bytes of the length field for an existing logBuffer. More...

static size_t	flatlogs::logHeader::lenSize (msgLenT &msgSz)
	Get the size in bytes of the length field for a logBuffer given the intended message length. More...

static int	flatlogs::logHeader::msgLen (bufferPtrT &logBuffer, const msgLenT &msgLen)
	Set the message length of a log entry message. More...

static msgLen0T	flatlogs::logHeader::msgLen0 (bufferPtrT &logBuffer)
	Extract the short message length of a log entry message. More...

static msgLen1T	flatlogs::logHeader::msgLen1 (bufferPtrT &logBuffer)
	Extract the medium message length of a log entry message. More...

static msgLenT	flatlogs::logHeader::msgLen (bufferPtrT &logBuffer)
	Extract the message length of a log entry message. More...

static size_t	flatlogs::logHeader::headerSize (bufferPtrT &logBuffer)
	Get the size of the header, including the variable size length field, for an existing logBuffer. More...

static size_t	flatlogs::logHeader::headerSize (msgLenT &msgSz)
	Get the size of the header, including the variable size length field, given a message size. More...

static size_t	flatlogs::logHeader::totalSize (bufferPtrT &logBuffer)
	Get the total size of the log entry, including the message buffer. More...

static size_t	flatlogs::logHeader::totalSize (msgLenT &msgSz)
	Get the total size of a log entry, given the message buffer size. More...

static void *	flatlogs::logHeader::messageBuffer (bufferPtrT &logBuffer)
	Get the message buffer address. More...

static int	flatlogs::logHeader::extractBasicLog (logPrioT &lvl, eventCodeT &ec, timespecX &ts, msgLenT &len, bufferPtrT &logBuffer)
	Extract the basic details of a log entry. More...

Detailed Description

Typedef Documentation

◆ bufferPtrT

typedef std::shared_ptr<char> flatlogs::bufferPtrT

The log entry buffer smart pointer.

Definition at line 57 of file logHeader.hpp.

Function Documentation

◆ eventCode() [1/2]

int flatlogs::logHeader::eventCode	(	bufferPtrT &	logBuffer,
		const eventCodeT &	ec
	)

inlinestatic

Set the event code of a log entry.

Returns: 0 on success; -1 on error

Parameters

[in,out]	logBuffer	a shared_ptr<char> containing a raw lag entry buffer.
[in]	ec	the new event code.

Definition at line 307 of file logHeader.hpp.

Referenced by flatlogs::logHeader::createLog(), flatlogs::logHeader::extractBasicLog(), and MagAOX::logger::logStdFormat().

◆ eventCode() [2/2]

eventCodeT flatlogs::logHeader::eventCode ( bufferPtrT & logBuffer )

inlinestatic

Extract the event code of a log entry.

Returns: the event code

Parameters

[in] logBuffer a shared_ptr<char> containing a raw lag entry buffer.

Definition at line 317 of file logHeader.hpp.

◆ extractBasicLog()

int flatlogs::logHeader::extractBasicLog	(	logPrioT &	lvl,
		eventCodeT &	ec,
		timespecX &	ts,
		msgLenT &	len,
		bufferPtrT &	logBuffer
	)

inlinestatic

Extract the basic details of a log entry.

Convenience wrapper for the other extraction functions.

Returns: 0 on success, -1 on error.

Parameters

[out]	lvl	The log level
[out]	ec	the event code
[out]	ts	the timestamp of the log entry
[out]	len	the message length
[in]	logBuffer	a shared_ptr<char> containing a raw log entry buffer.

Definition at line 481 of file logHeader.hpp.

Referenced by flatlogs::stdFormat().

◆ headerSize() [1/2]

size_t flatlogs::logHeader::headerSize ( bufferPtrT & logBuffer )

inlinestatic

Get the size of the header, including the variable size length field, for an existing logBuffer.

Returns: the size of the header in this log entry.

Parameters

[in] logBuffer a shared_ptr<char> containing a raw lag entry buffer.

Definition at line 364 of file logHeader.hpp.

Referenced by flatlogs::logHeader::messageBuffer(), and flatlogs::logHeader::totalSize().

◆ headerSize() [2/2]

size_t flatlogs::logHeader::headerSize ( msgLenT & msgSz )

inlinestatic

Get the size of the header, including the variable size length field, given a message size.

Returns: the size to be used for the header.

Parameters

[in] msgSz the size of the intended message.

Definition at line 370 of file logHeader.hpp.

◆ lenSize() [1/2]

size_t flatlogs::logHeader::lenSize ( bufferPtrT & logBuffer )

inlinestatic

Get the size in bytes of the length field for an existing logBuffer.

Returns: the number of bytes in the length field.

Parameters

[in] logBuffer a shared_ptr<char> containing a raw lag entry buffer.

Definition at line 339 of file logHeader.hpp.

Referenced by flatlogs::logHeader::headerSize().

◆ lenSize() [2/2]

size_t flatlogs::logHeader::lenSize ( msgLenT & msgSz )

inlinestatic

Get the size in bytes of the length field for a logBuffer given the intended message length.

Returns: the number of bytes to be put in the length field.

Parameters

[in] msgSz the size of the intended message.

Definition at line 354 of file logHeader.hpp.

◆ logLevel() [1/2]

int flatlogs::logHeader::logLevel	(	bufferPtrT &	logBuffer,
		const logPrioT &	lvl
	)

inlinestatic

Set the level of a log entry in a logBuffer header.

Returns: 0 on success; -1 on error

Parameters

[in,out]	logBuffer	a shared_ptr<char> containing a raw lag entry buffer.
[in]	lvl	the new log level.

Definition at line 291 of file logHeader.hpp.

Referenced by flatlogs::logHeader::createLog(), and flatlogs::logHeader::extractBasicLog().

◆ logLevel() [2/2]

logPrioT flatlogs::logHeader::logLevel ( bufferPtrT & logBuffer )

inlinestatic

Extract the level of a log entry.

Returns: the level

Parameters

[in] logBuffer a shared_ptr<char> containing a raw lag entry buffer.

Definition at line 301 of file logHeader.hpp.

◆ messageBuffer()

void * flatlogs::logHeader::messageBuffer ( bufferPtrT & logBuffer )

inlinestatic

Get the message buffer address.

Returns: the address of the message buffer.

Parameters

[in] logBuffer a shared_ptr<char> containing a raw lag entry buffer.

Definition at line 442 of file logHeader.hpp.

Referenced by flatlogs::logHeader::createLog(), and flatlogs::stdFormat().

◆ msgLen() [1/2]

int flatlogs::logHeader::msgLen	(	bufferPtrT &	logBuffer,
		const msgLenT &	msgLen
	)

inlinestatic

Set the message length of a log entry message.

Note: The logBuffer must already be allocated with a header large enough for this message size.

Returns: 0 on success; -1 on error

Parameters

[out]	logBuffer	a shared_ptr<char> containing a raw lag entry buffer allocated with large enough header for this message length.
[in]	msgLen	the message length to set.

Definition at line 376 of file logHeader.hpp.

Referenced by flatlogs::logHeader::createLog(), flatlogs::logHeader::extractBasicLog(), and flatlogs::logHeader::totalSize().

◆ msgLen() [2/2]

msgLenT flatlogs::logHeader::msgLen ( bufferPtrT & logBuffer )

inlinestatic

Extract the message length of a log entry message.

Returns: the message length

Parameters

[in] logBuffer a shared_ptr<char> containing a raw lag entry buffer.

Definition at line 414 of file logHeader.hpp.

◆ msgLen0()

msgLen0T flatlogs::logHeader::msgLen0 ( bufferPtrT & logBuffer )

inlinestatic

Extract the short message length of a log entry message.

This is always safe on a minimally allocated logBuffer, can be used to test for progressive reading.

Returns: the short message length field

Parameters

[in] logBuffer a shared_ptr<char> containing a raw lag entry buffer.

Definition at line 401 of file logHeader.hpp.

◆ msgLen1()

msgLen1T flatlogs::logHeader::msgLen1 ( bufferPtrT & logBuffer )

inlinestatic

Extract the medium message length of a log entry message.

This is NOT always safe, and should only be caled if msgLen0 is 0xFE. Can be used to test for progressive reading.

Returns: the medium message length field

Parameters

[in] logBuffer a shared_ptr<char> containing a raw lag entry buffer.

Definition at line 407 of file logHeader.hpp.

Referenced by flatlogs::logHeader::msgLen().

◆ timespec() [1/2]

timespecX flatlogs::logHeader::timespec ( bufferPtrT & logBuffer )

inlinestatic

Extract the timespec of a log entry.

Returns: the timespec

Parameters

[in] logBuffer a shared_ptr<char> containing a raw lag entry buffer.

Definition at line 323 of file logHeader.hpp.

Referenced by flatlogs::logHeader::createLog(), flatlogs::logHeader::extractBasicLog(), and MagAOX::logger::logFileRaw::writeLog().

◆ timespec() [2/2]

int flatlogs::logHeader::timespec	(	bufferPtrT &	logBuffer,
		const timespecX &	ts
	)

inlinestatic

Set the timespec of a log entry.

Returns: 0 on success; -1 on error

Parameters

[in,out]	logBuffer	a shared_ptr<char> containing a raw lag entry buffer.*/
[in]	ts	the new timespec

Definition at line 329 of file logHeader.hpp.

◆ totalSize() [1/2]

size_t flatlogs::logHeader::totalSize ( bufferPtrT & logBuffer )

inlinestatic

Get the total size of the log entry, including the message buffer.

Returns: the total size of this log entry.

Parameters

[in] logBuffer a shared_ptr<char> containing a raw lag entry buffer.

Definition at line 429 of file logHeader.hpp.

Referenced by flatlogs::logHeader::createLog(), and MagAOX::logger::logFileRaw::writeLog().

◆ totalSize() [2/2]

size_t flatlogs::logHeader::totalSize ( msgLenT & msgSz )

inlinestatic

Get the total size of a log entry, given the message buffer size.

Returns: the total size to be used for a log entry.

Parameters

[in] msgSz the intended size of the message buffer.

Definition at line 436 of file logHeader.hpp.

Modules

Classes

Typedefs

Functions

Detailed Description

Typedef Documentation

◆ bufferPtrT

Function Documentation

◆ eventCode() [1/2]

◆ eventCode() [2/2]

◆ extractBasicLog()

◆ headerSize() [1/2]

◆ headerSize() [2/2]

◆ lenSize() [1/2]

◆ lenSize() [2/2]

◆ logLevel() [1/2]

◆ logLevel() [2/2]

◆ messageBuffer()

◆ msgLen() [1/2]

◆ msgLen() [2/2]

◆ msgLen0()

◆ msgLen1()

◆ timespec() [1/2]

◆ timespec() [2/2]

◆ totalSize() [1/2]

◆ totalSize() [2/2]