:orphan: .. index:: pair: group; ICMP4 .. _doxid-group__tapi__tad__icmp4: ICMP4 ===== .. toctree:: :hidden: Overview ~~~~~~~~ Copyright (C) 2004-2022 OKTET Labs Ltd. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // global functions :ref:`te_errno` :ref:`tapi_icmp4_add_csap_layer`(:ref:`asn_value`** csap_spec); :ref:`te_errno` :ref:`tapi_icmp4_add_pdu`(:ref:`asn_value`** tmpl_or_ptrn, :ref:`asn_value`** pdu, bool is_pattern, int type, int code); :ref:`te_errno` :ref:`tapi_ipproto_ip4_icmp_ip4_eth_csap_create`(const char* ta_name, int sid, const char* eth_dev, unsigned int receive_mode, const uint8_t* eth_src, const uint8_t* eth_dst, in_addr_t src_addr, in_addr_t dst_addr, in_addr_t msg_src_addr, in_addr_t msg_dst_addr, int msg_src_port, int msg_dst_port, int ip_proto, :ref:`csap_handle_t`* ip_proto_csap); :ref:`te_errno` :ref:`tapi_tcp_ip4_icmp_ip4_eth_csap_create`(const char* ta_name, int sid, const char* eth_dev, unsigned int receive_mode, const uint8_t* eth_src, const uint8_t* eth_dst, in_addr_t src_addr, in_addr_t dst_addr, in_addr_t msg_src_addr, in_addr_t msg_dst_addr, int msg_src_port, int msg_dst_port, :ref:`csap_handle_t`* tcp_csap); :ref:`te_errno` :ref:`tapi_udp_ip4_icmp_ip4_eth_csap_create`(const char* ta_name, int sid, const char* eth_dev, unsigned int receive_mode, const uint8_t* eth_src, const uint8_t* eth_dst, in_addr_t src_addr, in_addr_t dst_addr, in_addr_t msg_src_addr, in_addr_t msg_dst_addr, int msg_src_port, int msg_dst_port, :ref:`csap_handle_t`* udp_csap); :ref:`te_errno` :ref:`tapi_icmp_ip4_eth_csap_create`(const char* ta_name, int sid, const char* eth_dev, unsigned int receive_mode, const uint8_t* eth_src, const uint8_t* eth_dst, in_addr_t src_addr, in_addr_t dst_addr, :ref:`csap_handle_t`* icmp_csap); :ref:`te_errno` :ref:`tapi_icmp_ip4_csap_create`(const char* ta_name, int sid, const char* ifname, in_addr_t src_addr, in_addr_t dst_addr, :ref:`csap_handle_t`* icmp_csap); .. _details-group__tapi__tad__icmp4: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved. Global Functions ---------------- .. index:: pair: function; tapi_icmp4_add_csap_layer .. _doxid-group__tapi__tad__icmp4_1ga710f9e9c2d8d3453ace13fb2c80f8b0e: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_icmp4_add_csap_layer(:ref:`asn_value`** csap_spec) Add ICMPv4 layer in CSAP specification. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - csap_spec - Location of CSAP specification pointer. * - Status - code. .. index:: pair: function; tapi_icmp4_add_pdu .. _doxid-group__tapi__tad__icmp4_1ga8ffc3daff1d4d6f62ebbc0aaaf5f6386: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_icmp4_add_pdu(:ref:`asn_value`** tmpl_or_ptrn, :ref:`asn_value`** pdu, bool is_pattern, int type, int code) Add ICMPv4 PDU as the last PDU to the last unit of the traffic template or pattern. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - tmpl_or_ptrn - Location of ASN.1 value with traffic template or pattern * - pdu - Location for ASN.1 value pointer with added PDU * - is_pattern - Is the first argument template or pattern * - type - Type of ICMP message or negative to keep unspecified. * - code - ICMP message code or negative to keep unspecified. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_ipproto_ip4_icmp_ip4_eth_csap_create .. _doxid-group__tapi__tad__icmp4_1ga862d82dcd23c68db65cb3dc98a1073be: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_ipproto_ip4_icmp_ip4_eth_csap_create(const char* ta_name, int sid, const char* eth_dev, unsigned int receive_mode, const uint8_t* eth_src, const uint8_t* eth_dst, in_addr_t src_addr, in_addr_t dst_addr, in_addr_t msg_src_addr, in_addr_t msg_dst_addr, int msg_src_port, int msg_dst_port, int ip_proto, :ref:`csap_handle_t`* ip_proto_csap) Create '{udp,tcp}.ip4.icmp.ip4.eth' CSAP on the specified Agent .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name * - sid - RCF SID * - eth_dev - Name of Ethernet interface * - receive_mode - Bitmask with receive mode, see 'enum tad_eth_recv_mode' in ``tad_common.h``. Use TAD_ETH_RECV_DEF by default. * - src_mac - Local MAC address (or NULL) * - dst_mac - Remote MAC address (or NULL) * - src_addr - Local IP address in network byte order (or NULL) * - dst_addr - Remote IP address in network byte order (or NULL) * - msg_src_addr - Source IPv4 Address of ICMP Error message * - msg_dst_addr - Destination IPv4 Address of ICMP Error message * - msg_src_port - Source UDP port in network byte order or -1 * - msg_dst_port - Destination UDP port in network byte order or -1 * - ip_proto - ``IPPROTO_UDP`` or ``IPPROTO_TCP`` * - ip_proto_csap - Location for the CSAP handle (OUT) .. rubric:: Returns: Statuc code .. index:: pair: function; tapi_tcp_ip4_icmp_ip4_eth_csap_create .. _doxid-group__tapi__tad__icmp4_1ga66ab876878d6aebab028211990175997: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_tcp_ip4_icmp_ip4_eth_csap_create(const char* ta_name, int sid, const char* eth_dev, unsigned int receive_mode, const uint8_t* eth_src, const uint8_t* eth_dst, in_addr_t src_addr, in_addr_t dst_addr, in_addr_t msg_src_addr, in_addr_t msg_dst_addr, int msg_src_port, int msg_dst_port, :ref:`csap_handle_t`* tcp_csap) Create 'tcp.ip4.icmp.ip4.eth' CSAP on the specified Agent .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name * - sid - RCF SID * - eth_dev - Name of Ethernet interface * - receive_mode - Bitmask with receive mode, see 'enum tad_eth_recv_mode' in ``tad_common.h``. Use TAD_ETH_RECV_DEF by default. * - src_mac - Local MAC address (or NULL) * - dst_mac - Remote MAC address (or NULL) * - src_addr - Local IP address in network byte order (or NULL) * - dst_addr - Remote IP address in network byte order (or NULL) * - msg_src_addr - Source IPv4 Address of ICMP Error message * - msg_dst_addr - Destination IPv4 Address of ICMP Error message * - msg_src_port - Source UDP port in network byte order or -1 * - msg_dst_port - Destination UDP port in network byte order or -1 * - tcp_csap - Location for the CSAP handle (OUT) .. rubric:: Returns: Zero on success or error code .. index:: pair: function; tapi_udp_ip4_icmp_ip4_eth_csap_create .. _doxid-group__tapi__tad__icmp4_1ga66dff2741941ac31ad5f3ad6fb677c4c: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_udp_ip4_icmp_ip4_eth_csap_create(const char* ta_name, int sid, const char* eth_dev, unsigned int receive_mode, const uint8_t* eth_src, const uint8_t* eth_dst, in_addr_t src_addr, in_addr_t dst_addr, in_addr_t msg_src_addr, in_addr_t msg_dst_addr, int msg_src_port, int msg_dst_port, :ref:`csap_handle_t`* udp_csap) Create 'udp.ip4.icmp.ip4.eth' CSAP on the specified Agent .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name * - sid - RCF SID * - eth_dev - Name of Ethernet interface * - receive_mode - Bitmask with receive mode, see 'enum tad_eth_recv_mode' in ``tad_common.h``. Use TAD_ETH_RECV_DEF by default. * - src_mac - Local MAC address (or NULL) * - dst_mac - Remote MAC address (or NULL) * - src_addr - Local IP address in network byte order (or NULL) * - dst_addr - Remote IP address in network byte order (or NULL) * - msg_src_addr - Source IPv4 Address of ICMP Error message * - msg_dst_addr - Destination IPv4 Address of ICMP Error message * - msg_src_port - Source UDP port in network byte order or -1 * - msg_dst_port - Destination UDP port in network byte order or -1 * - udp_csap - Location for the CSAP handle (OUT) .. rubric:: Returns: Zero on success or error code .. index:: pair: function; tapi_icmp_ip4_eth_csap_create .. _doxid-group__tapi__tad__icmp4_1gad02f1f481ec8aa32a55a8e4b76d3221b: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_icmp_ip4_eth_csap_create(const char* ta_name, int sid, const char* eth_dev, unsigned int receive_mode, const uint8_t* eth_src, const uint8_t* eth_dst, in_addr_t src_addr, in_addr_t dst_addr, :ref:`csap_handle_t`* icmp_csap) Create 'icmp.ip4.eth' CSAP on the specified Agent .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name * - sid - RCF SID * - eth_dev - Name of Ethernet interface * - receive_mode - Bitmask with receive mode, see 'enum tad_eth_recv_mode' in ``tad_common.h``. Use TAD_ETH_RECV_DEF by default. * - eth_src - Local MAC address (or NULL) * - eth_dst - Remote MAC address (or NULL) * - src_addr - Local IP address in network byte order (or NULL) * - dst_addr - Remote IP address in network byte order (or NULL) * - icmp_csap - Location for the CSAP handle (OUT) .. rubric:: Returns: Zero on success or error code .. index:: pair: function; tapi_icmp_ip4_csap_create .. _doxid-group__tapi__tad__icmp4_1ga44b0f4aabf054fa4711c7b44d43c2101: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_icmp_ip4_csap_create(const char* ta_name, int sid, const char* ifname, in_addr_t src_addr, in_addr_t dst_addr, :ref:`csap_handle_t`* icmp_csap) Create 'icmp.ip4' CSAP on the specified Agent .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name * - sid - RCF SID * - ifname - Name of interface * - src_addr - Local IP address in network byte order (or NULL) * - dst_addr - Remote IP address in network byte order (or NULL) * - icmp_csap - Location for the CSAP handle (OUT) .. rubric:: Returns: Zero on success or error code