:orphan:

.. index:: pair: group; API: Logger messages stack
.. _doxid-group__te__log__stack:

API: Logger messages stack
==========================

.. toctree::
	:hidden:

Overview
~~~~~~~~

In order to use logger_stack you need to include ``te_log_stack.h``

Usage examples:

.. :ref:`More...<details-group__te__log__stack>`


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

	
	// global functions

	void :ref:`te_log_stack_init_here<doxid-group__te__log__stack_1gaafa14538ddbd494529074ca88cf13a71>`(const char* top);
	void :ref:`te_log_stack_push_under<doxid-group__te__log__stack_1ga2a7f3ed9189d1e1c347a7ae54a924708>`(const char* user, const char* fmt, ...);
	char* :ref:`te_log_stack_pop<doxid-group__te__log__stack_1ga777d9b5481aef3ba1d23b9b2f07bb7a3>`(void);
	void :ref:`te_log_stack_dump<doxid-group__te__log__stack_1ga9587cc39dec179ad96ddfc38cd455cde>`(:ref:`te_log_level<doxid-te__raw__log_8h_1a48dfa90598c674ccedb448786e1252e6>` log_level);
	void :ref:`te_log_stack_maybe_reset<doxid-group__te__log__stack_1ga89c3569c596c4da3d7887429f17438ff>`(const char* here);

	// macros

	#define :target:`te_log_stack_init<doxid-group__te__log__stack_1ga88a4ef49e7bf25165322437b7ceea4f0>`()
	#define :ref:`te_log_stack_push<doxid-group__te__log__stack_1ga3217574b0f899e2ce636ffb24443a2aa>`(_fs...)
	#define :target:`te_log_stack_reset<doxid-group__te__log__stack_1ga8674ef8ace483d42c0ee6f0241e8cb34>`()

.. _details-group__te__log__stack:

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

In order to use logger_stack you need to include ``te_log_stack.h``

Usage examples:

.. ref-code-block:: cpp

	#define TE_LGR_USER  "My module"
	
	#include "te_config.h"
	...
	#include "te_log_stack.h"
	...
	int main()
	{
	    te_log_stack_init();
	
	    ...
	    :ref:`te_log_stack_push <doxid-group__te__log__stack_1ga3217574b0f899e2ce636ffb24443a2aa>`(:ref:`TE_LGR_USER <doxid-logger__defs_8h_1a06db0cce2a206028554692144999bab1>`, "An error condition happens: %s", result_string);
	    :ref:`CHECK_RC <doxid-group__te__ts__tapi__test__misc_1ga503a00c04b4caa0dbe1943277bc3946e>`(FUNCTION_THAT_WILL_DO_PUSH);

And then if failure was unexpected you can call:

.. ref-code-block:: cpp

	:ref:`te_log_stack_dump <doxid-group__te__log__stack_1ga9587cc39dec179ad96ddfc38cd455cde>`(:ref:`TE_LL_ERROR <doxid-logger__defs_8h_1a2544e937c6bf24efebe163214d543aca>`);

that will log full stack of errors and include them into your log file.

The stack is per-thread and is not allocated/initialized unless you call te_log_msg_stack_init() in the corresponding thread.

One limitation is that you can't use 'r' specifier.

Global Functions
----------------

.. index:: pair: function; te_log_stack_init_here
.. _doxid-group__te__log__stack_1gaafa14538ddbd494529074ca88cf13a71:

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

	void te_log_stack_init_here(const char* top)

Initialize msg stack logic in the thread and set "top" point, i.e. location that code-wise is the source of all calls. :ref:`te_log_stack_maybe_reset() <doxid-group__te__log__stack_1ga89c3569c596c4da3d7887429f17438ff>` calls will do nothing unless point at which we're calling things is the top one.



.. rubric:: Parameters:

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

	*
		- top

		- String identifier of the top point. See 'reset' handling.

.. index:: pair: function; te_log_stack_push_under
.. _doxid-group__te__log__stack_1ga2a7f3ed9189d1e1c347a7ae54a924708:

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

	void te_log_stack_push_under(const char* user, const char* fmt, ...)

Push a message under specified user



.. rubric:: Parameters:

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

	*
		- user

		- Log user to be used, if NULL - internal one will be used

	*
		- fmt

		- Format string ! r is not supported

.. index:: pair: function; te_log_stack_pop
.. _doxid-group__te__log__stack_1ga777d9b5481aef3ba1d23b9b2f07bb7a3:

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

	char* te_log_stack_pop(void)

Pop message from the stack. Note, that you should free() the result once done working with it.

.. index:: pair: function; te_log_stack_dump
.. _doxid-group__te__log__stack_1ga9587cc39dec179ad96ddfc38cd455cde:

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

	void te_log_stack_dump(:ref:`te_log_level<doxid-te__raw__log_8h_1a48dfa90598c674ccedb448786e1252e6>` log_level)

Dump stack under given log level.



.. rubric:: Parameters:

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

	*
		- log_level

		- Log level (TE_LL_ERROR etc.)

.. index:: pair: function; te_log_stack_maybe_reset
.. _doxid-group__te__log__stack_1ga89c3569c596c4da3d7887429f17438ff:

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

	void te_log_stack_maybe_reset(const char* here)

Reset/empty stack w/o logging things. Does not release any resources.



.. rubric:: Parameters:

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

	*
		- here

		- Name of the point we're resetting things from. Normally it's a file/function.

Macros
------

.. index:: pair: define; te_log_stack_push
.. _doxid-group__te__log__stack_1ga3217574b0f899e2ce636ffb24443a2aa:

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

	#define te_log_stack_push(_fs...)

Wrapper to used pre-defined TE_LGR_USER