:orphan: .. index:: pair: group; ICMP6 .. _doxid-group__tapi__tad__icmp6: ICMP6 ===== .. toctree:: :hidden: enum_icmp6_msg_type.rst enum_icmp6_opt_type.rst struct_echo_body.rst struct_icmp6_msg_body.rst struct_icmp6_msg_option.rst struct_nadv_body.rst struct_nsol_body.rst struct_prefix_info.rst struct_radv_body.rst Overview ~~~~~~~~ Copyright (C) 2004-2022 OKTET Labs Ltd. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // typedefs typedef struct :ref:`icmp6_msg_body` :ref:`icmp6_msg_body`; typedef struct :ref:`icmp6_msg_option` :ref:`icmp6_msg_option`; // enums enum :ref:`icmp6_msg_type`; enum :ref:`icmp6_opt_type`; // structs struct :ref:`echo_body`; struct :ref:`icmp6_msg_body`; struct :ref:`icmp6_msg_option`; struct :ref:`nadv_body`; struct :ref:`nsol_body`; struct :ref:`prefix_info`; struct :ref:`radv_body`; // global functions :ref:`te_errno` :ref:`tapi_icmp_ip6_eth_csap_create`(const char* ta_name, int sid, const char* eth_dev, unsigned int receive_mode, const uint8_t* loc_hwaddr, const uint8_t* rem_hwaddr, const uint8_t* loc_addr, const uint8_t* rem_addr, :ref:`csap_handle_t`* icmp_csap); :ref:`te_errno` :ref:`tapi_icmp6_add_pdu`(:ref:`asn_value`** tmpl_or_ptrn, :ref:`asn_value`** pdu, bool is_pattern, int type, int code, :ref:`icmp6_msg_body`* body, :ref:`icmp6_msg_option`* optlist); :ref:`te_errno` :ref:`tapi_icmp6_add_csap_layer`(:ref:`asn_value`** csap_spec); :ref:`te_errno` :ref:`tapi_ipproto_ip6_icmp_ip6_eth_csap_create`(const char* ta_name, int sid, const char* eth_dev, unsigned int receive_mode, const uint8_t* loc_eth, const uint8_t* rem_eth, const uint8_t* loc_addr, const uint8_t* rem_addr, const struct sockaddr_in6* msg_loc_saddr, const struct sockaddr_in6* msg_rem_saddr, int ip_proto, :ref:`csap_handle_t`* ip_proto_csap); :ref:`te_errno` :ref:`tapi_udp_ip6_icmp_ip6_eth_csap_create`(const char* ta_name, int sid, const char* eth_dev, unsigned int receive_mode, const uint8_t* loc_eth, const uint8_t* rem_eth, const uint8_t* loc_addr, const uint8_t* rem_addr, const struct sockaddr_in6* msg_loc_saddr, const struct sockaddr_in6* msg_rem_saddr, :ref:`csap_handle_t`* udp_csap); :ref:`te_errno` :ref:`tapi_tcp_ip6_icmp_ip6_eth_csap_create`(const char* ta_name, int sid, const char* eth_dev, unsigned int receive_mode, const uint8_t* loc_eth, const uint8_t* rem_eth, const uint8_t* loc_addr, const uint8_t* rem_addr, const struct sockaddr_in6* msg_loc_saddr, const struct sockaddr_in6* msg_rem_saddr, :ref:`csap_handle_t`* tcp_csap); .. _details-group__tapi__tad__icmp6: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved. Typedefs -------- .. index:: pair: typedef; icmp6_msg_body .. _doxid-group__tapi__tad__icmp6_1gaa7a899527bb1143e0036584fd2818dc8: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`icmp6_msg_body` icmp6_msg_body Structure to keep ICMPv6 message body information .. index:: pair: typedef; icmp6_msg_option .. _doxid-group__tapi__tad__icmp6_1ga5b3140927a50583ba71bd3b2f12cb159: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`icmp6_msg_option` icmp6_msg_option Structure to keep list of ICMPv6 options Global Functions ---------------- .. index:: pair: function; tapi_icmp_ip6_eth_csap_create .. _doxid-group__tapi__tad__icmp6_1gae5e4a137a0ba1eaebe1f9f612b2f7036: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_icmp_ip6_eth_csap_create(const char* ta_name, int sid, const char* eth_dev, unsigned int receive_mode, const uint8_t* loc_hwaddr, const uint8_t* rem_hwaddr, const uint8_t* loc_addr, const uint8_t* rem_addr, :ref:`csap_handle_t`* icmp_csap) Create 'icmp6.ip6.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. * - loc_hwaddr - Local MAC address (or NULL) * - rem_hwaddr - Remote MAC address (or NULL) * - loc_addr - Local IP address in network byte order (or NULL) * - rem_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_icmp6_add_pdu .. _doxid-group__tapi__tad__icmp6_1ga1fe23ae3ef1c9b65227f80a0e3977d0c: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_icmp6_add_pdu(:ref:`asn_value`** tmpl_or_ptrn, :ref:`asn_value`** pdu, bool is_pattern, int type, int code, :ref:`icmp6_msg_body`* body, :ref:`icmp6_msg_option`* optlist) Add ICMPv6 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 ICMPv6 message or negative to keep unspecified * - code - ICMPv6 message code or negative to keep unspecified * - body - ICMPv6 message body or NULL to keep unspecified * - optlist - List of ICPMv6 options or NULL to keep unspecified .. rubric:: Returns: Status code. .. index:: pair: function; tapi_icmp6_add_csap_layer .. _doxid-group__tapi__tad__icmp6_1gaf1335c245fe8127f83a71a5f06a9152d: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_icmp6_add_csap_layer(:ref:`asn_value`** csap_spec) Add ICMPv6 layer in CSAP specification. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - csap_spec - Location of CSAP specification pointer. * - Status - code. .. index:: pair: function; tapi_ipproto_ip6_icmp_ip6_eth_csap_create .. _doxid-group__tapi__tad__icmp6_1gaa0650162e449cbbbe2d97f6c44c2293e: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_ipproto_ip6_icmp_ip6_eth_csap_create(const char* ta_name, int sid, const char* eth_dev, unsigned int receive_mode, const uint8_t* loc_eth, const uint8_t* rem_eth, const uint8_t* loc_addr, const uint8_t* rem_addr, const struct sockaddr_in6* msg_loc_saddr, const struct sockaddr_in6* msg_rem_saddr, int ip_proto, :ref:`csap_handle_t`* ip_proto_csap) Create '{udp,tcp}.ip6.icmp.ip6.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. * - loc_eth - Local MAC address (or NULL) * - rem_eth - Remote MAC address (or NULL) * - loc_addr - Local IPv6 address (or NULL) * - rem_addr - Remote IPv6 address (or NULL) * - msg_loc_saddr - Local IPv6 address/port of ICMP Error message (or NULL) * - msg_rem_saddr - Remote IPv6 address/port of ICMP Error message (or NULL) * - ip_proto - ``IPPROTO_UDP`` or ``IPPROTO_TCP`` * - ip_proto_csap - Location for the CSAP handle (OUT) .. rubric:: Returns: Status code .. index:: pair: function; tapi_udp_ip6_icmp_ip6_eth_csap_create .. _doxid-group__tapi__tad__icmp6_1gacf76769313ad453dfb1ff858d57fe7ce: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_udp_ip6_icmp_ip6_eth_csap_create(const char* ta_name, int sid, const char* eth_dev, unsigned int receive_mode, const uint8_t* loc_eth, const uint8_t* rem_eth, const uint8_t* loc_addr, const uint8_t* rem_addr, const struct sockaddr_in6* msg_loc_saddr, const struct sockaddr_in6* msg_rem_saddr, :ref:`csap_handle_t`* udp_csap) Create 'udp.ip6.icmp.ip6.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. * - loc_eth - Local MAC address (or NULL) * - rem_eth - Remote MAC address (or NULL) * - loc_addr - Local IPv6 address (or NULL) * - rem_addr - Remote IPv6 address (or NULL) * - msg_loc_saddr - Local IPv6 address/port of ICMP Error message (or NULL) * - msg_rem_saddr - Remote IPv6 address/port of ICMP Error message (or NULL) * - udp_csap - Location for the CSAP handle (OUT) .. rubric:: Returns: Status code .. index:: pair: function; tapi_tcp_ip6_icmp_ip6_eth_csap_create .. _doxid-group__tapi__tad__icmp6_1ga162e38d93eb1ad83ecc0b1cd2019ca8a: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_tcp_ip6_icmp_ip6_eth_csap_create(const char* ta_name, int sid, const char* eth_dev, unsigned int receive_mode, const uint8_t* loc_eth, const uint8_t* rem_eth, const uint8_t* loc_addr, const uint8_t* rem_addr, const struct sockaddr_in6* msg_loc_saddr, const struct sockaddr_in6* msg_rem_saddr, :ref:`csap_handle_t`* tcp_csap) Create 'tcp.ip6.icmp.ip6.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. * - loc_eth - Local MAC address (or NULL) * - rem_eth - Remote MAC address (or NULL) * - loc_addr - Local IPv6 address (or NULL) * - rem_addr - Remote IPv6 address (or NULL) * - msg_loc_saddr - Local IPv6 address/port of ICMP Error message (or NULL) * - msg_rem_saddr - Remote IPv6 address/port of ICMP Error message (or NULL) * - tcp_csap - Location for the CSAP handle (OUT) .. rubric:: Returns: Status code