:orphan:

.. index:: pair: group; API: Logger
.. _doxid-group__logger__api:

API: Logger
===========

.. toctree::
	:hidden:

Overview
~~~~~~~~

In order to use :ref:`API: Logger <doxid-group__logger__api>` you need to include `logger_api.h <logger__api_8h.html>`__ file into your sources. :ref:`More...<details-group__logger__api>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	
	// macros

	#define :ref:`ENTRY<doxid-group__logger__api_1ga02bfdb68ee815c98c614d7edf19e122e>`(_fs...)
	#define :ref:`ERROR<doxid-group__logger__api_1gab917aa4a73d839cc18faff31b013d680>`(_fs...)
	#define :ref:`EXIT<doxid-group__logger__api_1ga51aaf0b1817f579662645cb6c2548aea>`(_fs...)
	#define :ref:`INFO<doxid-group__logger__api_1gaa2da67464d48c3529acab6e54a97515b>`(_fs...)
	#define :ref:`LGR_MESSAGE<doxid-group__logger__api_1ga68d9687838fce12874226ffa586a6374>`(_lvl, _lgruser, _fs...)
	#define :ref:`LOG_MSG<doxid-group__logger__api_1gae6d959919c8095ae1f9688c21d3d9e30>`(_lvl, _fs...)
	#define :ref:`RING<doxid-group__logger__api_1ga7b815b8f872c9036bba29ddfecd07368>`(_fs...)
	#define :ref:`TE_DO_IF_LOG_LEVEL<doxid-group__logger__api_1ga32078acc43083474fd4d7cba9eeafef0>`(_lvl, ...)
	#define :ref:`TE_LOG<doxid-group__logger__api_1ga1e2e2bb915c181f07bbfabcced727ae5>`(_level, _entity, _user, _fs...)
	#define :ref:`TE_LOG_ENTRY<doxid-group__logger__api_1ga128545b688ab5c125726878c8569cb77>`(_us, _fs...)
	#define :ref:`TE_LOG_ERROR<doxid-group__logger__api_1gafed22ba2610939bdc31d1cec9f5c26d8>`(_us, _fs...)
	#define :ref:`TE_LOG_EXIT<doxid-group__logger__api_1gabdd596a897633a1ceabbece6a3253937>`(_us, _fs...)
	#define :ref:`TE_LOG_INFO<doxid-group__logger__api_1ga78c3f85b77c989106cb55d41c0d9d9b3>`(_us, _fs...)
	#define :ref:`TE_LOG_ONCE<doxid-group__logger__api_1gae9113b30be6100630348e3654c31bd9b>`(_log_fn, _fs...)
	#define :ref:`TE_LOG_RING<doxid-group__logger__api_1ga02ef6e3089ef06b5f22721b06a76b44b>`(_us, _fs...)
	#define :ref:`TE_LOG_VERB<doxid-group__logger__api_1ga55ad9e88ac1244ef7769bf398a211b9a>`(_us, _fs...)
	#define :ref:`TE_LOG_WARN<doxid-group__logger__api_1ga435e374b37e8d851cd29323e4c1ba08e>`(_us, _fs...)
	#define :ref:`VERB<doxid-group__logger__api_1ga44b30c7ecb5a931abda27f5ede014926>`(_fs...)
	#define :ref:`WARN<doxid-group__logger__api_1gaf2e7f5ba954abedfcea33ca79e197e7d>`(_fs...)
	#define :ref:`_LOG_ENTRY<doxid-group__logger__api_1ga1d968a2225b5594eccb5044486c8366c>`(_us, _fs, _args...)
	#define :ref:`_LOG_EXIT<doxid-group__logger__api_1ga725be86a9ad920ebd7b8c0c2802a58a5>`(_us, _fs, _args...)

.. _details-group__logger__api:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

In order to use :ref:`API: Logger <doxid-group__logger__api>` you need to include `logger_api.h <logger__api_8h.html>`__ file into your sources.

If you want to use short versions of :ref:`API: Logger <doxid-group__logger__api>` functions you need to define TE_LGR_USER macro at the beginning of source file.

For example your code might look like:

.. ref-code-block:: cpp

	#define TE_LGR_USER  "My module"
	
	#include "te_config.h"
	...
	#include "logger_api.h"
	...
	ERROR("An error condition happens: %s", result_string);

Macros
------

.. index:: pair: define; ENTRY
.. _doxid-group__logger__api_1ga02bfdb68ee815c98c614d7edf19e122e:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define ENTRY(_fs...)

Logging of entry to a function



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- _fs

		- format string and arguments

.. index:: pair: define; ERROR
.. _doxid-group__logger__api_1gab917aa4a73d839cc18faff31b013d680:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define ERROR(_fs...)

Logging abnormal/unexpected situations with user-defined log user name TE_LGR_USER.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- _fs

		- format string and arguments

.. index:: pair: define; EXIT
.. _doxid-group__logger__api_1ga51aaf0b1817f579662645cb6c2548aea:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define EXIT(_fs...)

Logging of exit from a function



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- _fs

		- format string and arguments

.. index:: pair: define; INFO
.. _doxid-group__logger__api_1gaa2da67464d48c3529acab6e54a97515b:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define INFO(_fs...)

Logging important event for debugging of the test



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- _fs

		- format string and arguments

.. index:: pair: define; LGR_MESSAGE
.. _doxid-group__logger__api_1ga68d9687838fce12874226ffa586a6374:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define LGR_MESSAGE(_lvl, _lgruser, _fs...)

Log message of the specified level from the user.

This macro is intended for internal purposes and should not be used directly outside of this file.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- _lvl

		- log level of the message

	*
		- _lgruser

		- log user name

	*
		- _fs

		- format string and arguments

.. index:: pair: define; LOG_MSG
.. _doxid-group__logger__api_1gae6d959919c8095ae1f9688c21d3d9e30:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define LOG_MSG(_lvl, _fs...)

Log message from default user with specified level.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- _lvl

		- log level of the message

	*
		- _fs

		- format string and arguments

.. index:: pair: define; RING
.. _doxid-group__logger__api_1ga7b815b8f872c9036bba29ddfecd07368:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define RING(_fs...)

Logging very important events in TE and tests required to understand testing results



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- _fs

		- format string and arguments

.. index:: pair: define; TE_DO_IF_LOG_LEVEL
.. _doxid-group__logger__api_1ga32078acc43083474fd4d7cba9eeafef0:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define TE_DO_IF_LOG_LEVEL(_lvl, ...)

Expand variadic arguments only if ``_lvl`` is currently enabled.

The macro is intended to wrap other logging functions, e.g.:

.. ref-code-block:: cpp

	TE_IF_LOG_LEVEL(:ref:`TE_LL_VERB <doxid-logger__defs_8h_1a1ff30bc4604230d8632b900befec900d>`, log_pkt_contents(pkt))



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- _lvl

		- Log level

	*
		- ...

		- The code to be executed only if ``_lvl`` is enabled

.. index:: pair: define; TE_LOG
.. _doxid-group__logger__api_1ga1e2e2bb915c181f07bbfabcced727ae5:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define TE_LOG(_level, _entity, _user, _fs...)

Unconditional logging.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- _level

		- log level of the message

	*
		- _entity

		- log entity name

	*
		- _user

		- log user name

	*
		- _fs

		- format string and arguments

.. index:: pair: define; TE_LOG_ENTRY
.. _doxid-group__logger__api_1ga128545b688ab5c125726878c8569cb77:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define TE_LOG_ENTRY(_us, _fs...)

Logging of entry to a function



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- _us

		- log user name

	*
		- _fs

		- format string and arguments

.. index:: pair: define; TE_LOG_ERROR
.. _doxid-group__logger__api_1gafed22ba2610939bdc31d1cec9f5c26d8:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define TE_LOG_ERROR(_us, _fs...)

Logging abnormal/unexpected situations



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- _us

		- log user name

	*
		- _fs

		- format string and arguments

.. index:: pair: define; TE_LOG_EXIT
.. _doxid-group__logger__api_1gabdd596a897633a1ceabbece6a3253937:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define TE_LOG_EXIT(_us, _fs...)

Logging of exit from a function



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- _us

		- log user name

	*
		- _fs

		- format string and arguments

.. index:: pair: define; TE_LOG_INFO
.. _doxid-group__logger__api_1ga78c3f85b77c989106cb55d41c0d9d9b3:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define TE_LOG_INFO(_us, _fs...)

Logging important event for debugging of the test



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- _us

		- log user name

	*
		- _fs

		- format string and arguments

.. index:: pair: define; TE_LOG_ONCE
.. _doxid-group__logger__api_1gae9113b30be6100630348e3654c31bd9b:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define TE_LOG_ONCE(_log_fn, _fs...)

Log a message once at a given place.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- _log_fn

		- Name of a logging macro, e.g. ``ERROR``, ``WARN``, ``RING``, etc.

	*
		- _fs

		- Format string and arguments.

.. index:: pair: define; TE_LOG_RING
.. _doxid-group__logger__api_1ga02ef6e3089ef06b5f22721b06a76b44b:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define TE_LOG_RING(_us, _fs...)

Logging very important events in TE and tests required to understand testing results



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- _us

		- log user name

	*
		- _fs

		- format string and arguments

.. index:: pair: define; TE_LOG_VERB
.. _doxid-group__logger__api_1ga55ad9e88ac1244ef7769bf398a211b9a:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define TE_LOG_VERB(_us, _fs...)

Logging additional events for detalization of processing



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- _us

		- log user name

	*
		- _fs

		- format string and arguments

.. index:: pair: define; TE_LOG_WARN
.. _doxid-group__logger__api_1ga435e374b37e8d851cd29323e4c1ba08e:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define TE_LOG_WARN(_us, _fs...)

Logging situations of some failed initialization of the optional feature or some unexpected events that does not break operation



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- _us

		- log user name

	*
		- _fs

		- format string and arguments

.. index:: pair: define; VERB
.. _doxid-group__logger__api_1ga44b30c7ecb5a931abda27f5ede014926:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define VERB(_fs...)

Logging additional events for detalization of processing



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- _fs

		- format string and arguments

.. index:: pair: define; WARN
.. _doxid-group__logger__api_1gaf2e7f5ba954abedfcea33ca79e197e7d:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define WARN(_fs...)

Logging situations some failed initialization of the optional feature



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- _fs

		- format string and arguments

.. index:: pair: define; _LOG_ENTRY
.. _doxid-group__logger__api_1ga1d968a2225b5594eccb5044486c8366c:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define _LOG_ENTRY(_us, _fs, _args...)

Auxiliary macro to insert **FUNCTION** just after format string before arguments.

.. index:: pair: define; _LOG_EXIT
.. _doxid-group__logger__api_1ga725be86a9ad920ebd7b8c0c2802a58a5:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define _LOG_EXIT(_us, _fs, _args...)

Auxiliary macro to insert **LINE** and **FUNCTION** just after format string before arguments.