:orphan: .. index:: pair: group; Network sniffers configuration .. _doxid-group__tapi__conf__sniffer: Network sniffers configuration ============================== .. toctree:: :hidden: struct_tapi_sniff_list_s.rst struct_tapi_sniffer_id.rst Overview ~~~~~~~~ Definition of API to configure sniffers. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // typedefs typedef struct :ref:`tapi_sniffer_id` :ref:`tapi_sniffer_id`; typedef struct :ref:`tapi_sniff_list_s` :ref:`tapi_sniff_list_s`; typedef struct sniffl_h_t :target:`sniffl_h_t`; // structs struct :ref:`tapi_sniff_list_s`; struct :ref:`tapi_sniffer_id`; // global functions :target:`SLIST_HEAD`(sniffl_h_t, :ref:`tapi_sniff_list_s`); :ref:`te_errno` :ref:`tapi_sniffer_common_snaplen_set`(const char* ta, int snaplen); :ref:`tapi_sniffer_id`* :ref:`tapi_sniffer_add`(const char* ta, const char* iface, const char* name, const char* filter, bool ofill); :ref:`te_errno` :ref:`tapi_sniffer_add_mult`(const char* ta, const char* iface, const char* name, const char* filter, bool ofill, sniffl_h_t* snif_h); :ref:`te_errno` :ref:`tapi_sniffer_del`(:ref:`tapi_sniffer_id`* id); :ref:`te_errno` :ref:`tapi_sniffer_stop`(:ref:`tapi_sniffer_id`* id); :ref:`te_errno` :ref:`tapi_sniffer_start`(:ref:`tapi_sniffer_id`* id); :ref:`te_errno` :ref:`tapi_sniffer_mark`(const char* ta, :ref:`tapi_sniffer_id`* id, const char* description); .. _details-group__tapi__conf__sniffer: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Definition of API to configure sniffers. Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved. Typedefs -------- .. index:: pair: typedef; tapi_sniffer_id .. _doxid-group__tapi__conf__sniffer_1ga71bff414aee9856f7e823d4845ec46fe: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_sniffer_id` tapi_sniffer_id Sniffer identifier .. index:: pair: typedef; tapi_sniff_list_s .. _doxid-group__tapi__conf__sniffer_1ga6026d796b3e8e1edbe4a13dfb1eb6388: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_sniff_list_s` tapi_sniff_list_s Sniffers list Global Functions ---------------- .. index:: pair: function; tapi_sniffer_common_snaplen_set .. _doxid-group__tapi__conf__sniffer_1ga2c2b388abd61b231d1ac5b425827f75d: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_sniffer_common_snaplen_set(const char* ta, int snaplen) Set common sniffer snapshot length value for the agent ``ta``. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Agent name * - snaplen - Snapshot length value * - 0 - success .. rubric:: Returns: Status code .. index:: pair: function; tapi_sniffer_add .. _doxid-group__tapi__conf__sniffer_1gaf7ed4e7a0248e4acb1ea413f3b298a41: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`tapi_sniffer_id`* tapi_sniffer_add(const char* ta, const char* iface, const char* name, const char* filter, bool ofill) Create and start new sniffer. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Agent name * - iface - Interface name * - name - Sniffer name ``NULL`` Name will be generated automatically * - filter - Filter expression ``NULL`` If NULL is specified - the filter is not applied * - ofill - If ``false`` is specified, than overfill handling method is rotation. Otherwise - tail drop .. rubric:: Returns: Pointer to identifier structure of the sniffer. In case of failure NULL will be returned. .. index:: pair: function; tapi_sniffer_add_mult .. _doxid-group__tapi__conf__sniffer_1gabf821fe391565f4d2e5484a694257fe1: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_sniffer_add_mult(const char* ta, const char* iface, const char* name, const char* filter, bool ofill, sniffl_h_t* snif_h) Create and start one or more new sniffers on the agent. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Agent name * - iface - Interface name ``NULL`` Start sniffers on all interfaces expect loopback * - name - Sniffer name ``NULL`` Name will be generated automatically * - filter - Filter expression ``NULL`` If NULL is specified - the filter is not applied * - ofill - If ``false`` is specified, than overfill handling method is rotation. Otherwise - tail drop * - snif_h - Pointer to head of sniffer list * - 0 - success .. rubric:: Returns: Status code .. index:: pair: function; tapi_sniffer_del .. _doxid-group__tapi__conf__sniffer_1ga7fd980f27d5df1a6634070940fcaafa6: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_sniffer_del(:ref:`tapi_sniffer_id`* id) Stop and destroy the sniffer. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - id - ID of the sniffer * - 0 - success .. rubric:: Returns: Status code .. index:: pair: function; tapi_sniffer_stop .. _doxid-group__tapi__conf__sniffer_1ga8f71654d401a43e93adb7a7300b8c559: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_sniffer_stop(:ref:`tapi_sniffer_id`* id) Disable the sniffer. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - id - ID of the sniffer * - 0 - success .. rubric:: Returns: Status code .. index:: pair: function; tapi_sniffer_start .. _doxid-group__tapi__conf__sniffer_1gaafbe355ff750f5f852c38559663c88c6: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_sniffer_start(:ref:`tapi_sniffer_id`* id) Enable the sniffer. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - id - ID of the sniffer * - 0 - success .. rubric:: Returns: Status code .. index:: pair: function; tapi_sniffer_mark .. _doxid-group__tapi__conf__sniffer_1gaa3964975aea8c7dbcd29d04aa5b114aa: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_sniffer_mark(const char* ta, :ref:`tapi_sniffer_id`* id, const char* description) Insert a mark packet into the capture file for a certain sniffer. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Agent name used to request mark for all sniffers. It is not used if the ID not NULL ``NULL`` The sniffer ID should not be NULL * - id - ID of the sniffer. If ID not NULL is queried mark for one sniffer ``NULL`` If ID is NULL is queried mark for all sniffers on the agent. The ta param should not be NULL * - description - Mark description in human-readable form ``NULL`` NULL may be used as description for empty description string * - 0 - success .. rubric:: Returns: Status code