:orphan: .. index:: pair: group; PCAP .. _doxid-group__tapi__tad__pcap: PCAP ==== .. toctree:: :hidden: Overview ~~~~~~~~ Copyright (C) 2004-2022 OKTET Labs Ltd. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // typedefs typedef void (*:ref:`tapi_pcap_recv_callback`)( int filter_id, const uint8_t *pkt_data, uint16_t pkt_len, void *user_data ); // global functions int :ref:`tapi_pcap_add_csap_layer`(:ref:`asn_value`** csap_spec, const char* ifname, unsigned int iftype, unsigned int recv_mode); int :ref:`tapi_pcap_csap_create`(const char* ta_name, int sid, const char* ifname, unsigned int iftype, unsigned int recv_mode, :ref:`csap_handle_t`* pcap_csap); :ref:`tapi_tad_trrecv_cb_data`* :ref:`tapi_pcap_trrecv_cb_data`(:ref:`tapi_pcap_recv_callback` callback, void* user_data); int :ref:`tapi_pcap_pattern_add`(const char* filter, const int filter_id, :ref:`asn_value`** pattern); // macros #define :ref:`PCAP_LINKTYPE_DEFAULT` #define :ref:`PCAP_RECV_MODE_ALL` #define :ref:`PCAP_RECV_MODE_DEF` .. _details-group__tapi__tad__pcap: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved. Typedefs -------- .. index:: pair: typedef; tapi_pcap_recv_callback .. _doxid-group__tapi__tad__pcap_1ga7581f41dc10457979bf2aea0650fe748: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef void (*tapi_pcap_recv_callback)( int filter_id, const uint8_t *pkt_data, uint16_t pkt_len, void *user_data ) Callback function for the tapi_pcap_pkt_handler() routine, it is called for each packet received for csap. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - filter_id - Filter ID that corresponds to received packet. * - pkt_data - Received packet in binary form. * - pkt_len - Length of the received packet. * - user_data - Pointer to user data, passed to tapi_pcap_pkt_handler() in *user_param* as *user_data* field of tapi_pcap_pkt_handler_data. Global Functions ---------------- .. index:: pair: function; tapi_pcap_add_csap_layer .. _doxid-group__tapi__tad__pcap_1ga662a4bef0c51fa62ff2b0686f1f5b8b7: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_pcap_add_csap_layer(:ref:`asn_value`** csap_spec, const char* ifname, unsigned int iftype, unsigned int recv_mode) Add Ethernet-PCAP CSAP layer. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - csap_spec - Location of the CSAP specification * - ifname - Interface name on TA host * - iftype - Interface datalink type (see man pcap) * - recv_mode - Receive mode, bit scale defined by elements of 'enum pcap_csap_receive_mode' in ``ndn_pcap.h``. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_pcap_csap_create .. _doxid-group__tapi__tad__pcap_1gaee7898b6399403e21c3147db34e18f08: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_pcap_csap_create(const char* ta_name, int sid, const char* ifname, unsigned int iftype, unsigned int recv_mode, :ref:`csap_handle_t`* pcap_csap) Create common Ethernet-PCAP CSAP. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name * - sid - RCF session * - ifname - Interface name on TA host * - iftype - Interface datalink type (see man pcap) * - recv_mode - Receive mode, bit scale defined by elements of 'enum pcap_csap_receive_mode' in ``ndn_pcap.h``. * - pcap_csap - Identifier of created CSAP (OUT) .. rubric:: Returns: Status code. .. index:: pair: function; tapi_pcap_trrecv_cb_data .. _doxid-group__tapi__tad__pcap_1ga7a3a414ee3273c8b57873eac579c4c46: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`tapi_tad_trrecv_cb_data`* tapi_pcap_trrecv_cb_data(:ref:`tapi_pcap_recv_callback` callback, void* user_data) Prepare PCAP callback data for :ref:`tapi_tad_trrecv_get() `, :ref:`tapi_tad_trrecv_stop() ` or :ref:`tapi_tad_trrecv_wait() ` routines. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - callback - User callback to be called for each received packet * - user_data - Opaque user data to be passed to *callback* .. rubric:: Returns: Allocated structure to be passed to :ref:`tapi_tad_trrecv_get() `, :ref:`tapi_tad_trrecv_stop() ` or :ref:`tapi_tad_trrecv_wait() ` as *cb_data*. .. index:: pair: function; tapi_pcap_pattern_add .. _doxid-group__tapi__tad__pcap_1ga89439fc1fc0b7c57faac395203353eca: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_pcap_pattern_add(const char* filter, const int filter_id, :ref:`asn_value`** pattern) Creates traffic pattern for a single Ethernet-PCAP frame. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - filter - Tcpdump-like filtering rule * - filter_id - Value that should be responsed when packet match filtering rule * - pattern - Placeholder for the pattern (OUT) .. rubric:: Returns: Status of the operation Macros ------ .. index:: pair: define; PCAP_LINKTYPE_DEFAULT .. _doxid-group__tapi__tad__pcap_1gae83218ba39d936e394deaa43ebf69f6b: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define PCAP_LINKTYPE_DEFAULT Default PCAP link type is 10/100 MBit/s ethernet (see 'man 3 pcap' for other types) .. index:: pair: define; PCAP_RECV_MODE_ALL .. _doxid-group__tapi__tad__pcap_1ga27163f04ac42c84640a1effa04c2354e: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define PCAP_RECV_MODE_ALL Receive all packets mode .. index:: pair: define; PCAP_RECV_MODE_DEF .. _doxid-group__tapi__tad__pcap_1ga3b8c03fe672a5fbd2de2eb3135a87592: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define PCAP_RECV_MODE_DEF Default recv mode: all except OUTGOING packets.