:orphan: .. index:: pair: group; Serial console parsers configuration .. _doxid-group__tapi__conf__serial__parse: Serial console parsers configuration ==================================== .. toctree:: :hidden: struct_tapi_parser_id.rst Overview ~~~~~~~~ Definition of API to configure serial console parsers. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // typedefs typedef struct :ref:`tapi_parser_id` :ref:`tapi_parser_id`; // structs struct :ref:`tapi_parser_id`; // global functions :ref:`te_errno` :ref:`tapi_serial_tester_event_add`(const char* name); void :ref:`tapi_serial_tester_event_del`(const char* name); :ref:`te_errno` :ref:`tapi_serial_handler_ext_add`(const char* ev_name, const char* h_name, int priority, const char* path); :ref:`te_errno` :ref:`tapi_serial_handler_int_add`(const char* ev_name, const char* h_name, int priority, int signo); void :ref:`tapi_serial_handler_del`(const char* ev_name, const char* h_name); :ref:`tapi_parser_id`* :ref:`tapi_serial_id_init`(const char* agent, const char* c_name, const char* name); void :ref:`tapi_serial_id_cleanup`(:ref:`tapi_parser_id`* id); :ref:`te_errno` :ref:`tapi_serial_parser_add`(:ref:`tapi_parser_id`* id); void :ref:`tapi_serial_parser_del`(:ref:`tapi_parser_id`* id); :ref:`te_errno` :ref:`tapi_serial_parser_enable`(:ref:`tapi_parser_id`* id); :ref:`te_errno` :ref:`tapi_serial_parser_disable`(:ref:`tapi_parser_id`* id); :ref:`te_errno` :ref:`tapi_serial_logging_enable`(:ref:`tapi_parser_id`* id, const char* level); :ref:`te_errno` :ref:`tapi_serial_logging_disable`(:ref:`tapi_parser_id`* id); :ref:`te_errno` :ref:`tapi_serial_parser_event_add`(:ref:`tapi_parser_id`* id, const char* name, const char* t_name); void :ref:`tapi_serial_parser_event_del`(:ref:`tapi_parser_id`* id, const char* name); int :ref:`tapi_serial_parser_pattern_add`(:ref:`tapi_parser_id`* id, const char* e_name, const char* pattern); void :ref:`tapi_serial_parser_pattern_del`(:ref:`tapi_parser_id`* id, const char* e_name, int pat_i); :ref:`te_errno` :ref:`tapi_serial_parser_reset`(:ref:`tapi_parser_id`* id); :ref:`te_errno` :ref:`tapi_serial_parser_event_get_count`(const :ref:`tapi_parser_id`* id, const char* e_name, int* count); // macros #define :target:`TE_SERIAL_MAX_NAME` #define :target:`TE_SERIAL_MAX_PATH` #define :target:`TE_SERIAL_PARSER_PORT` #define :target:`TE_SERIAL_PARSER_USER` .. _details-group__tapi__conf__serial__parse: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Definition of API to configure serial console parsers. See design document OKTL-0000469-SERIAL.txt. User manual: `https://oktetlabs.ru/dokuwiki/doku.php/te/serial_console_parser `__ Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved. Typedefs -------- .. index:: pair: typedef; tapi_parser_id .. _doxid-group__tapi__conf__serial__parse_1ga973cde9f9e257025670799e5c24cb214: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_parser_id` tapi_parser_id Structure describes the parser identificator Global Functions ---------------- .. index:: pair: function; tapi_serial_tester_event_add .. _doxid-group__tapi__conf__serial__parse_1ga4c7bb5a9e58102271389925821a14b05: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_serial_tester_event_add(const char* name) Create a new empty Tester event .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - name - Event name .. rubric:: Returns: Status code .. index:: pair: function; tapi_serial_tester_event_del .. _doxid-group__tapi__conf__serial__parse_1ga82da16b743cac54925bdb94a750c365c: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_serial_tester_event_del(const char* name) Remove a Tester event .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - name - Event name .. index:: pair: function; tapi_serial_handler_ext_add .. _doxid-group__tapi__conf__serial__parse_1gac48e06fdf874f80ddb7e7b7ab4f7c38c: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_serial_handler_ext_add(const char* ev_name, const char* h_name, int priority, const char* path) Add a new external handler for event .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ev_name - Event name * - h_name - Handler name * - priority - Handler priority * - path - Path to the handler .. rubric:: Returns: Status code .. index:: pair: function; tapi_serial_handler_int_add .. _doxid-group__tapi__conf__serial__parse_1gac24e5a443328699945cd12cf726222c9: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_serial_handler_int_add(const char* ev_name, const char* h_name, int priority, int signo) Add a new internal handler for event .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ev_name - Event name * - h_name - Handler name * - priority - Handler priority * - signo - Signal number .. rubric:: Returns: Status code .. index:: pair: function; tapi_serial_handler_del .. _doxid-group__tapi__conf__serial__parse_1ga01d7a107919442e9c1052391122d1f0e: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_serial_handler_del(const char* ev_name, const char* h_name) Remove handler .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ev_name - Event name * - h_name - Handler name .. index:: pair: function; tapi_serial_id_init .. _doxid-group__tapi__conf__serial__parse_1gaa1598eafe8187b8326548d6c4b3d4ed5: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`tapi_parser_id`* tapi_serial_id_init(const char* agent, const char* c_name, const char* name) Initialization of the parser id. The function calls the malloc. User should call cleanup function (:ref:`tapi_serial_id_cleanup() `) after use. By default conserver port value 3109 will be assigned. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - agent - Agent name * - c_name - Serial console name * - name - The parser name .. index:: pair: function; tapi_serial_id_cleanup .. _doxid-group__tapi__conf__serial__parse_1ga77e9ef3c3fae27066d9b1d0ed845a0f5: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_serial_id_cleanup(:ref:`tapi_parser_id`* id) Cleanup and free the parser id .. index:: pair: function; tapi_serial_parser_add .. _doxid-group__tapi__conf__serial__parse_1gaea32180e50a0f557029153a14f893c67: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_serial_parser_add(:ref:`tapi_parser_id`* id) Create and launch a new parser .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - id - Location of the parser id .. rubric:: Returns: Status code .. index:: pair: function; tapi_serial_parser_del .. _doxid-group__tapi__conf__serial__parse_1ga077347579c30c438668a154ff11a17b2: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_serial_parser_del(:ref:`tapi_parser_id`* id) Stop and remove parser .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - id - Location of the parser id .. index:: pair: function; tapi_serial_parser_enable .. _doxid-group__tapi__conf__serial__parse_1ga3231daccd714639c7e1d036953474ca7: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_serial_parser_enable(:ref:`tapi_parser_id`* id) Start a parser thread .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - id - Location of the parser id .. rubric:: Returns: Status code .. index:: pair: function; tapi_serial_parser_disable .. _doxid-group__tapi__conf__serial__parse_1ga8fa0d73c92db2e83619a7d6475db9cc4: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_serial_parser_disable(:ref:`tapi_parser_id`* id) Stop a parser thread .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - id - Location of the parser id .. rubric:: Returns: Status code .. index:: pair: function; tapi_serial_logging_enable .. _doxid-group__tapi__conf__serial__parse_1gad7c4bac1650b08935dc985b3fbcb281a: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_serial_logging_enable(:ref:`tapi_parser_id`* id, const char* level) Enable logging of the serial console to main log .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - id - Location of the parser id * - level - Level name of the message for logging(``logger_defs.h``) Use NULL to no change the value. .. index:: pair: function; tapi_serial_logging_disable .. _doxid-group__tapi__conf__serial__parse_1gaa90d25627c9a45bcd2001096e8c8a6a3: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_serial_logging_disable(:ref:`tapi_parser_id`* id) Disable logging of the serial console to main log .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - id - Location of the parser id .. index:: pair: function; tapi_serial_parser_event_add .. _doxid-group__tapi__conf__serial__parse_1gaebdda6d5d89dd63c67efd27357592f02: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_serial_parser_event_add(:ref:`tapi_parser_id`* id, const char* name, const char* t_name) Add parser event to the parser .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - id - Location of the parser id * - name - The parser event name * - t_name - The Tester event name. Use a name of one of the events declarated in the Tester subtree. Use empty string if you do not need any processing on Tester .. rubric:: Returns: Status code .. index:: pair: function; tapi_serial_parser_event_del .. _doxid-group__tapi__conf__serial__parse_1ga5d04ead7291145d6f43cb1c250363b50: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_serial_parser_event_del(:ref:`tapi_parser_id`* id, const char* name) Delete parser event .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - id - Location of the parser id * - name - The parser event name .. index:: pair: function; tapi_serial_parser_pattern_add .. _doxid-group__tapi__conf__serial__parse_1ga346e54a874bd6bc10ea40934c02159d7: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_serial_parser_pattern_add(:ref:`tapi_parser_id`* id, const char* e_name, const char* pattern) Add a pattern to the parser event .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - id - Location of the parser id * - e_name - The parser event name * - pattern - The pattern string .. rubric:: Returns: Index number of pattern or ``-1`` in case of failure .. index:: pair: function; tapi_serial_parser_pattern_del .. _doxid-group__tapi__conf__serial__parse_1ga7a10dbea26e36ae8ceb4f7b742f6b8f2: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_serial_parser_pattern_del(:ref:`tapi_parser_id`* id, const char* e_name, int pat_i) Remove a pattern from the parser event .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - id - Location of the parser id * - e_name - The parser event name * - pat_i - Index of the pattern .. index:: pair: function; tapi_serial_parser_reset .. _doxid-group__tapi__conf__serial__parse_1ga95eb2af2a49385caaecaabfbfb33d6c3: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_serial_parser_reset(:ref:`tapi_parser_id`* id) Reset status for each event of the parser .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - id - Location of the parser id .. rubric:: Returns: Status code .. index:: pair: function; tapi_serial_parser_event_get_count .. _doxid-group__tapi__conf__serial__parse_1ga027ce4561c5c1ff0fc239a478c246927: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_serial_parser_event_get_count(const :ref:`tapi_parser_id`* id, const char* e_name, int* count) Get number of times that a given parser event occurred. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - id - Location of the parser ID * - e_name - Event name * - count - Where to save the requested number .. rubric:: Returns: Status code.