:orphan: .. index:: pair: group; Log buffers .. _doxid-group__te__tools__log__bufs: Log buffers =========== .. toctree:: :hidden: struct_te_log_buf_bit2str.rst struct_te_log_buf_flag2str.rst Overview ~~~~~~~~ Declaration of API to collect long log messages. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // typedefs typedef struct :ref:`te_log_buf_bit2str` :ref:`te_bit2str`; typedef struct :ref:`te_log_buf_flag2str` :ref:`te_flag2str`; typedef struct te_log_buf :target:`te_log_buf`; // structs struct :ref:`te_log_buf_bit2str`; struct :ref:`te_log_buf_flag2str`; // global functions void :ref:`te_log_bufs_cleanup`(void); :ref:`te_string`* :ref:`te_log_str_alloc`(void); :ref:`te_errno` :ref:`te_args2te_str`(:ref:`te_string`* str, int argc, const char** argv); :ref:`te_errno` :ref:`te_bit_mask2te_str`(:ref:`te_string`* str, unsigned long long bit_mask, const :ref:`te_bit2str`* map); :ref:`te_errno` :ref:`te_extended_bit_mask2te_str`(:ref:`te_string`* str, unsigned long long bit_mask, const :ref:`te_bit2str`* bm, const :ref:`te_flag2str`* fm); te_log_buf* :ref:`te_log_buf_alloc`(void); int :ref:`te_log_buf_append`(te_log_buf* buf, const char* fmt, ...); const char* :ref:`te_log_buf_get`(te_log_buf* buf); void :ref:`te_log_buf_free`(te_log_buf* buf); const char* :ref:`te_args2log_buf`(te_log_buf* buf, int argc, const char** argv); const char* :ref:`te_bit_mask2log_buf`(te_log_buf* buf, unsigned long long bit_mask, const struct :ref:`te_log_buf_bit2str`* map); const char* :ref:`te_extended_bit_mask2log_buf`(te_log_buf* buf, unsigned long long bit_mask, const struct :ref:`te_log_buf_bit2str`* bm, const struct :ref:`te_log_buf_flag2str`* fm); const char* :ref:`te_ether_addr2log_buf`(te_log_buf* buf, const uint8_t* mac_addr); .. _details-group__te__tools__log__bufs: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Declaration of API to collect long log messages. Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved. Typedefs -------- .. index:: pair: typedef; te_bit2str .. _doxid-group__te__tools__log__bufs_1ga784f8831855041c45c7a1fe19f579827: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`te_log_buf_bit2str` te_bit2str Mapping of the bit number to string .. index:: pair: typedef; te_flag2str .. _doxid-group__te__tools__log__bufs_1ga2787a6191853a228d4e07db5027389c9: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`te_log_buf_flag2str` te_flag2str Mapping of the flag within mask to string Global Functions ---------------- .. index:: pair: function; te_log_bufs_cleanup .. _doxid-group__te__tools__log__bufs_1gaaa5acf9dc459da17c5981d9bd27657fb: .. ref-code-block:: cpp :class: doxyrest-title-code-block void te_log_bufs_cleanup(void) Free all resources allocated for logging buffers. This function actually destroys all the existing buffers, not just marks them free for further use. .. index:: pair: function; te_log_str_alloc .. _doxid-group__te__tools__log__bufs_1ga494840b2232a5f0b0ddb4cb982edcb6c: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_string`* te_log_str_alloc(void) Obtain reusable TE string for logging. The string can then be used like a normal TE string, however its buffer cannot be replaced by te_string_set_buf(). Obtained string must be released with :ref:`te_string_free() `. .. rubric:: Returns: TE string pointer or ``NULL`` on failure. .. index:: pair: function; te_args2te_str .. _doxid-group__te__tools__log__bufs_1gacd9283c48802b50abdc50291df3faf27: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` te_args2te_str(:ref:`te_string`* str, int argc, const char** argv) Append argc/ *argv* arguments enclosed in double quotes and separated by comma to TE string. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - str - Pointer to TE string * - argc - Number of arguments * - argv - Array with arguments .. rubric:: Returns: Status code. .. index:: pair: function; te_bit_mask2te_str .. _doxid-group__te__tools__log__bufs_1gaca353302ce482d89b649299d40e2ee69: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` te_bit_mask2te_str(:ref:`te_string`* str, unsigned long long bit_mask, const :ref:`te_bit2str`* map) Append bit mask converted to string to TE string. Pipe '\|' is used as a separator. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - str - Pointer to TE string * - bit_mask - Bit mask * - map - Bit to string map terminated by the element with ``NULL`` string .. rubric:: Returns: Status code. .. index:: pair: function; te_extended_bit_mask2te_str .. _doxid-group__te__tools__log__bufs_1ga37d67947f3284b59d67eec3ed4f5f713: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` te_extended_bit_mask2te_str(:ref:`te_string`* str, unsigned long long bit_mask, const :ref:`te_bit2str`* bm, const :ref:`te_flag2str`* fm) Extended version of :ref:`te_bit_mask2te_str() `. First it checks for all bits from ``bm``, unsetting them in ``bit_mask``. Then the bits which are left are checked against flags from ``fm``. Pipe '\|' is used as a separator. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - str - Pointer to TE string * - bit_mask - Bit mask * - bm - Bit to string map terminated by the element with ``NULL`` string * - fm - Flag within some mask to string map terminated by the element with ``NULL`` string .. rubric:: Returns: Status code. .. index:: pair: function; te_log_buf_alloc .. _doxid-group__te__tools__log__bufs_1gaa090c14355d08927f7044b629e29f9bb: .. ref-code-block:: cpp :class: doxyrest-title-code-block te_log_buf* te_log_buf_alloc(void) Allocates a buffer to be used for accumulating log message. Mainly used in tapi_snmp itself. This function is deprecated. Use :ref:`te_log_str_alloc() `. the caller does not have to check the returned value against NULL, the function blocks the caller until it gets available buffer. This is thread safe function .. rubric:: Returns: Pointer to the buffer. .. index:: pair: function; te_log_buf_append .. _doxid-group__te__tools__log__bufs_1gae6fdd86c85bf8bac6589d83685a68b86: .. ref-code-block:: cpp :class: doxyrest-title-code-block int te_log_buf_append(te_log_buf* buf, const char* fmt, ...) Appends format string to the log message, the behaviour of the function is the same as ordinary printf-like function. This is NOT thread safe function, so you are not allowed to append the same buffer from different threads simultaneously. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - buf - Pointer to the buffer allocated with :ref:`te_log_buf_alloc() ` * - fmt - Format string followed by parameters .. rubric:: Returns: The number of characters appended .. index:: pair: function; te_log_buf_get .. _doxid-group__te__tools__log__bufs_1ga3572173ef56a5ab41c84c444a6363e07: .. ref-code-block:: cpp :class: doxyrest-title-code-block const char* te_log_buf_get(te_log_buf* buf) Returns current log message accumulated in the buffer. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - buf - Pointer to the buffer .. rubric:: Returns: log message .. index:: pair: function; te_log_buf_free .. _doxid-group__te__tools__log__bufs_1gaf269fbb875614673e90c3af7898d915c: .. ref-code-block:: cpp :class: doxyrest-title-code-block void te_log_buf_free(te_log_buf* buf) Release buffer allocated by :ref:`te_log_buf_alloc() ` This is thread safe function .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - buf - Pointer to the buffer .. index:: pair: function; te_args2log_buf .. _doxid-group__te__tools__log__bufs_1ga3151c59e43d04a0784fa299e0a2f245a: .. ref-code-block:: cpp :class: doxyrest-title-code-block const char* te_args2log_buf(te_log_buf* buf, int argc, const char** argv) Put argc/ *argv* arguments enclosed in double quotes and separated by comma to log buffer. This function is deprecated. :ref:`te_args2te_str() ` can be used with TE string instead. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - buf - Pointer to the buffer allocated with :ref:`te_log_buf_alloc() ` * - argc - Number of arguments * - argv - Array with arguments .. rubric:: Returns: :ref:`te_log_buf_get() ` return value after addition .. index:: pair: function; te_bit_mask2log_buf .. _doxid-group__te__tools__log__bufs_1ga6c6bd9bf641b346e885cbc77191c96eb: .. ref-code-block:: cpp :class: doxyrest-title-code-block const char* te_bit_mask2log_buf(te_log_buf* buf, unsigned long long bit_mask, const struct :ref:`te_log_buf_bit2str`* map) Append bit mask converted to string to log buffer. Pipe '\|' is used as a separator. This function is deprecated. :ref:`te_bit_mask2te_str() ` can be used with TE string instead. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - buf - Pointer to the buffer * - bit_mask - Bit mask * - map - Bit to string map terminated by the element with ``NULL`` string .. rubric:: Returns: :ref:`te_log_buf_get() ` value. .. index:: pair: function; te_extended_bit_mask2log_buf .. _doxid-group__te__tools__log__bufs_1ga7116fcacee660dc4f1223498d5f39db8: .. ref-code-block:: cpp :class: doxyrest-title-code-block const char* te_extended_bit_mask2log_buf(te_log_buf* buf, unsigned long long bit_mask, const struct :ref:`te_log_buf_bit2str`* bm, const struct :ref:`te_log_buf_flag2str`* fm) Append extended bit mask converted to string to log buffer. Pipe '\|' is used as a separator. This function is deprecated. :ref:`te_extended_bit_mask2te_str() ` can be used with TE string instead. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - buf - Pointer to the buffer * - bit_mask - Bit mask * - bm - Bit to string map terminated by the element with ``NULL`` string * - fm - Flag within some mask to string map terminated by the element with ``NULL`` string .. rubric:: Returns: :ref:`te_log_buf_get() ` value. .. index:: pair: function; te_ether_addr2log_buf .. _doxid-group__te__tools__log__bufs_1ga5d89216be950c94cbc6dc4acbdc3c27c: .. ref-code-block:: cpp :class: doxyrest-title-code-block const char* te_ether_addr2log_buf(te_log_buf* buf, const uint8_t* mac_addr) Put ether address to log buffer. This function is deprecated. :ref:`te_mac_addr2te_str() ` can be used with TE string instead. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - buf - Pointer to the buffer allocated with :ref:`te_log_buf_alloc() ` * - mac_addr - Pointer to the ether address .. rubric:: Returns: :ref:`te_log_buf_get() ` return value after addition