Api.h File Reference

#include "colony_config.h"
#include "Cpl/Logging/EntryData_T.h"
#include "Cpl/Logging/TimeApi.h"
#include "Cpl/Logging/Private_.h"
#include "Cpl/Dm/Mp/Uint32.h"
#include "Cpl/Container/RingBufferMP.h"
#include <stdint.h>

Include dependency graph for Api.h:

Go to the source code of this file.

Namespaces
namespace	Cpl
	The 'Cpl' namespace is the root name space for the Colony.
namespace	Cpl::Logging
	The 'Logging' namespace provides a framework for Logging events.

Macros
#define	OPTION_CPL_LOGGING_MIN_QUEUE_SPACE   3
	Number of 'empty slots' required after encountering a full entry queue before resuming adding entries to the queue.

Functions
void	Cpl::Logging::initialize (Cpl::Container::RingBufferMP< EntryData_T > &logEntryFIFO, uint32_t categoryIdForQueueOverflow, const char *categoryQueueOverflowText, uint16_t messageIdForQueueOverflow, const char *messageQueueOverflowText) noexcept
	This method is used to initialize the Logging framework.
void	Cpl::Logging::shutdown () noexcept
	This method is used to shutdown/stop the Logging framework.
uint32_t	Cpl::Logging::enableCategory (uint32_t categoryMask) noexcept
	This method is used to enable one or more log Categories.
uint32_t	Cpl::Logging::disableCategory (uint32_t categoryMask) noexcept
	This method is used to disable one or more log Categories.
void	Cpl::Logging::setCategoryMask (uint32_t newMask) noexcept
	This method is used to explicit set the category mask (i.e.
uint32_t	Cpl::Logging::getCategoryEnabledMask () noexcept
	This method returns the current enabled/disabled Category mask.
template<class CATEGORY_ID , class MESSAGE_ID >
void	Cpl::Logging::vlogf (CATEGORY_ID catId, MESSAGE_ID msgId, const char *msgTextFormat, va_list ap) noexcept
	This method is used to create log entry.
bool	Cpl::Logging::getIDStrings (uint32_t categoryNumericValue, uint16_t messageIdNumericValue, Cpl::Text::String &dstCategoryString, Cpl::Text::String &dstMessageString) noexcept
	This method is implemented the application - it converts numeric values for the Category and Message IDs into text strings.

Macro Definition Documentation

OPTION_CPL_LOGGING_MIN_QUEUE_SPACE

#define OPTION_CPL_LOGGING_MIN_QUEUE_SPACE   3

Number of 'empty slots' required after encountering a full entry queue before resuming adding entries to the queue.

This value can NOT be less than 2.