:orphan: .. index:: pair: group; Common functions for IPv4 and IPv6 .. _doxid-group__tapi__tad__ip__common: Common functions for IPv4 and IPv6 ================================== .. toctree:: :hidden: struct_tapi_ip_frag_spec.rst Overview ~~~~~~~~ Declaration of common functions for IPv4/IPv6 CSAP. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // typedefs typedef struct :ref:`tapi_ip_frag_spec` :ref:`tapi_ip_frag_spec`; // structs struct :ref:`tapi_ip_frag_spec`; // global functions void :ref:`tapi_ip_frag_specs_init`(:ref:`tapi_ip_frag_spec`* frags, unsigned int num); :ref:`te_errno` :ref:`tapi_ip_eth_csap_create`(const char* ta_name, int sid, const char* eth_dev, unsigned int receive_mode, const uint8_t* loc_mac_addr, const uint8_t* rem_mac_addr, int af, const void* loc_ip_addr, const void* rem_ip_addr, int ip_proto, :ref:`csap_handle_t`* ip_csap); :ref:`te_errno` :ref:`tapi_tcp_udp_ip_eth_csap_create`(const char* ta_name, int sid, const char* eth_dev, unsigned int receive_mode, const uint8_t* loc_mac_addr, const uint8_t* rem_mac_addr, int af, int ip_proto, const void* loc_ip_addr, const void* rem_ip_addr, int loc_port, int rem_port, :ref:`csap_handle_t`* csap); :ref:`te_errno` :ref:`tapi_ip_pdu_tmpl_fragments`(:ref:`asn_value`** tmpl, :ref:`asn_value`** pdu, bool ipv4, :ref:`tapi_ip_frag_spec`* fragments, unsigned int num_frags); .. _details-group__tapi__tad__ip__common: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Declaration of common functions for IPv4/IPv6 CSAP. Copyright (C) 2019-2022 OKTET Labs Ltd. All rights reserved. Typedefs -------- .. index:: pair: typedef; tapi_ip_frag_spec .. _doxid-group__tapi__tad__ip__common_1gae0510d03bcd8d592cfccb8d3ff77b7e0: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_ip_frag_spec` tapi_ip_frag_spec Specification of IPv4 or IPv6 fragment Global Functions ---------------- .. index:: pair: function; tapi_ip_frag_specs_init .. _doxid-group__tapi__tad__ip__common_1ga880722626c51d194fe35c831ca123627: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_ip_frag_specs_init(:ref:`tapi_ip_frag_spec`* frags, unsigned int num) Initialize array of IP fragment specifications. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - frags - Pointer to array. * - num - Number of fragment specifications. .. index:: pair: function; tapi_ip_eth_csap_create .. _doxid-group__tapi__tad__ip__common_1ga279eef8b7a2ba6bf38c5e8c9db64b9b2: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_ip_eth_csap_create(const char* ta_name, int sid, const char* eth_dev, unsigned int receive_mode, const uint8_t* loc_mac_addr, const uint8_t* rem_mac_addr, int af, const void* loc_ip_addr, const void* rem_ip_addr, int ip_proto, :ref:`csap_handle_t`* ip_csap) Create CSAP for IPv4 or IPv6 traffic. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name. * - sid - RCF SID. * - eth_dev - Name of Ethernet interface. * - receive_mode - Receive mode for Ethernet Layer on the interface. * - loc_mac_addr - Local MAC address (or ``NULL``). * - rem_mac_addr - Remote MAC address (or ``NULL``). * - af - Address family (``AF_INET`` or ``AF_INET6``). * - loc_ip_addr - Pointer to local IPv4 or IPv6 address (or ``NULL``). * - rem_ip_addr - Pointer to remote IPv4 or IPv6 address (or ``NULL``). * - proto - IP protocol or negative number. * - ip_csap - Where to save pointer to created CSAP. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_tcp_udp_ip_eth_csap_create .. _doxid-group__tapi__tad__ip__common_1gab494d21dd537c885df60a6cf1b2d8279: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_tcp_udp_ip_eth_csap_create(const char* ta_name, int sid, const char* eth_dev, unsigned int receive_mode, const uint8_t* loc_mac_addr, const uint8_t* rem_mac_addr, int af, int ip_proto, const void* loc_ip_addr, const void* rem_ip_addr, int loc_port, int rem_port, :ref:`csap_handle_t`* csap) Create CSAP for TCP or UDP IPv4 or IPv6 traffic. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name. * - sid - RCF SID. * - eth_dev - Name of Ethernet interface. * - receive_mode - Receive mode for Ethernet Layer on the interface. * - loc_mac_addr - Local MAC address (or ``NULL``). * - rem_mac_addr - Remote MAC address (or ``NULL``). * - af - Address family (``AF_INET`` or ``AF_INET6``). * - ip_proto - ``IPPROTO_TCP`` or ``IPPROTO_UDP``. * - loc_ip_addr - Pointer to local IPv4 or IPv6 address (or ``NULL``). * - rem_ip_addr - Pointer to remote IPv4 or IPv6 address (or ``NULL``). * - loc_port - Local port number in network byte order or ``-1``. * - rem_port - Remote port number in network byte order or ``-1``. * - csap - Where to save pointer to created CSAP. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_ip_pdu_tmpl_fragments .. _doxid-group__tapi__tad__ip__common_1ga65736a90df563dbd606e4a66d4a67b04: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_ip_pdu_tmpl_fragments(:ref:`asn_value`** tmpl, :ref:`asn_value`** pdu, bool ipv4, :ref:`tapi_ip_frag_spec`* fragments, unsigned int num_frags) Add fragments specification to IPv4 or IPv6 PDU. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - tmpl - ``NULL`` or location of ASN.1 value with traffic template where IP PDU should be added * - pdu - If ``tmpl`` is ``NULL``, this parameter must point to IP PDU where to add fragments specification; on return, if this parameter is not ``NULL``, pointer to IP PDU will be saved in it * - ipv4 - If ``true``, IPv4 PDU is processed, otherwise IPv6 PDU * - fragments - Array with IP fragments specifications * - num_frags - Number of IP fragments .. rubric:: Returns: Status code.