:orphan: .. index:: pair: group; UDP .. _doxid-group__tapi__tad__udp: UDP === .. toctree:: :hidden: struct_udp4_datagram.rst Overview ~~~~~~~~ Copyright (C) 2004-2022 OKTET Labs Ltd. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // typedefs typedef struct :ref:`udp4_datagram` :ref:`udp4_datagram`; typedef void (*:ref:`udp4_callback`)( const udp4_datagram *pkt, void *userdata ); // structs struct :ref:`udp4_datagram`; // global functions :ref:`te_errno` :ref:`tapi_udp_add_csap_layer`(:ref:`asn_value`** csap_spec, int local_port, int remote_port); :ref:`te_errno` :ref:`tapi_udp_add_pdu`(:ref:`asn_value`** tmpl_or_ptrn, :ref:`asn_value`** pdu, bool is_pattern, int src_port, int dst_port); :ref:`te_errno` :ref:`tapi_udp_ip4_eth_csap_create`(const char* ta_name, int sid, const char* eth_dev, unsigned int receive_mode, const uint8_t* loc_mac, const uint8_t* rem_mac, in_addr_t loc_addr, in_addr_t rem_addr, int loc_port, int rem_port, :ref:`csap_handle_t`* udp_csap); :ref:`te_errno` :ref:`tapi_udp_ip4_csap_create`(const char* ta_name, int sid, const char* ifname, in_addr_t loc_addr, in_addr_t rem_addr, int loc_port, int rem_port, :ref:`csap_handle_t`* udp_csap); int :ref:`ndn_udp4_dgram_to_plain`(:ref:`asn_value`* pkt, struct :ref:`udp4_datagram`** udp_dgram); :ref:`tapi_tad_trrecv_cb_data`* :ref:`tapi_udp_ip4_eth_trrecv_cb_data`(:ref:`udp4_callback` callback, void* user_data); int :ref:`tapi_udp_ip4_eth_recv_start`(const char* ta_name, int sid, :ref:`csap_handle_t` csap, :ref:`rcf_trrecv_mode` mode); :ref:`te_errno` :ref:`tapi_udp_ip6_eth_csap_create`(const char* ta_name, int sid, const char* eth_dev, unsigned int receive_mode, const uint8_t* loc_mac, const uint8_t* rem_mac, const uint8_t* loc_addr, const uint8_t* rem_addr, int loc_port, int rem_port, :ref:`csap_handle_t`* udp_csap); :ref:`te_errno` :ref:`tapi_udp_ip_eth_csap_create`(const char* ta_name, int sid, const char* eth_dev, unsigned int receive_mode, const uint8_t* loc_mac, const uint8_t* rem_mac, int ip_family, const void* loc_addr, const void* rem_addr, int loc_port, int rem_port, :ref:`csap_handle_t`* udp_csap); .. _details-group__tapi__tad__udp: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved. Typedefs -------- .. index:: pair: typedef; udp4_datagram .. _doxid-group__tapi__tad__udp_1ga6e40a7f4dfc59805798ab716fd82c5b5: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`udp4_datagram` udp4_datagram Structure of UDP/IPv4 datagram .. index:: pair: typedef; udp4_callback .. _doxid-group__tapi__tad__udp_1ga26f655a6c32b0991fe81007d9c2712ac: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef void (*udp4_callback)( const udp4_datagram *pkt, void *userdata ) Callback function for the receiving UDP datagrams. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - pkt - Received UDP datagram. After return from this callback memory block under this datagram will be freed. * - userdata - Parameter, provided by the caller of :ref:`tapi_snmp_walk() `. Global Functions ---------------- .. index:: pair: function; tapi_udp_add_csap_layer .. _doxid-group__tapi__tad__udp_1ga2cd2f1efc8ef104bacefabe86bbcacc3: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_udp_add_csap_layer(:ref:`asn_value`** csap_spec, int local_port, int remote_port) Add UDP layer in CSAP specification. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - csap_spec - Location of CSAP specification pointer. * - local_port - Default local port in network byte order or -1 to keep unspecified * - remote_port - Default remote port in network byte order or -1 to keep unspecified * - Status - code. .. index:: pair: function; tapi_udp_add_pdu .. _doxid-group__tapi__tad__udp_1ga0ae004a1fad2ec751a9634e94ea49865: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_udp_add_pdu(:ref:`asn_value`** tmpl_or_ptrn, :ref:`asn_value`** pdu, bool is_pattern, int src_port, int dst_port) Add UDP 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 * - src_port - Source port in network byte order or -1. If -1, default value is specified during CSAP creation (as local port for sending, as remote port for receiving). * - dst_addr - Destination port in network byte order or -1. If -1, default value is specified during CSAP creation (as remote port for sending, as local port for receiving). .. rubric:: Returns: Status code. .. index:: pair: function; tapi_udp_ip4_eth_csap_create .. _doxid-group__tapi__tad__udp_1ga9d16748fade27cbc758d5f025df219e9: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_udp_ip4_eth_csap_create(const char* ta_name, int sid, const char* eth_dev, unsigned int receive_mode, const uint8_t* loc_mac, const uint8_t* rem_mac, in_addr_t loc_addr, in_addr_t rem_addr, int loc_port, int rem_port, :ref:`csap_handle_t`* udp_csap) Create 'udp.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. * - loc_mac - Local MAC address (or NULL) * - rem_mac - 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) * - loc_port - Local UDP port in network byte order or -1 * - rem_port - Remote 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_udp_ip4_csap_create .. _doxid-group__tapi__tad__udp_1ga46b9a1482d4bed53a55897cf3367daac: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_udp_ip4_csap_create(const char* ta_name, int sid, const char* ifname, in_addr_t loc_addr, in_addr_t rem_addr, int loc_port, int rem_port, :ref:`csap_handle_t`* udp_csap) Create 'udp.ip4' CSAP on the specified Agent .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name * - loc_addr - Local IP address in network byte order (or NULL) * - rem_addr - Remote IP address in network byte order (or NULL) * - loc_port - Local UDP port in network byte order or -1 * - rem_port - Remote 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; ndn_udp4_dgram_to_plain .. _doxid-group__tapi__tad__udp_1gad52ec5abd55c4b573a47cadf5ab94aea: .. ref-code-block:: cpp :class: doxyrest-title-code-block int ndn_udp4_dgram_to_plain(:ref:`asn_value`* pkt, struct :ref:`udp4_datagram`** udp_dgram) Convert UDP.IPv4 datagram ASN.1 value to plain C structure. Function allocates memory under :ref:`dhcp_message ` data structure, which should be freed with dhcpv4_message_destroy .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - pkt - ASN.1 value of type Raw-Packet. * - udp_dgram - converted structure (OUT). .. rubric:: Returns: zero on success or error code. .. index:: pair: function; tapi_udp_ip4_eth_trrecv_cb_data .. _doxid-group__tapi__tad__udp_1ga9f52bd084345632c8d4086cf48c0dca3: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`tapi_tad_trrecv_cb_data`* tapi_udp_ip4_eth_trrecv_cb_data(:ref:`udp4_callback` callback, void* user_data) Prepare callback data to be passed in tapi_tad_trrecv\_{wait,stop,get} to process received UDP packet. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - callback - Callback for UDP packets handling * - user_data - User-supplied data to be passed to *callback* .. rubric:: Returns: Pointer to allocated callback data or NULL. .. index:: pair: function; tapi_udp_ip4_eth_recv_start .. _doxid-group__tapi__tad__udp_1gaabbfae1361437fc9d5529ff05936a130: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_udp_ip4_eth_recv_start(const char* ta_name, int sid, :ref:`csap_handle_t` csap, :ref:`rcf_trrecv_mode` mode) Start receiving of UDP datagrams via 'udp.ip4.eth' CSAP, non-block method. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name * - sid - RCF SID * - csap - Identifier of CSAP * - mode - Count received packets only or store packets to get to the test side later .. rubric:: Returns: Zero on success or error code. .. index:: pair: function; tapi_udp_ip6_eth_csap_create .. _doxid-group__tapi__tad__udp_1ga45907f3d4a5f7270eb4e9ebc74e583c4: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_udp_ip6_eth_csap_create(const char* ta_name, int sid, const char* eth_dev, unsigned int receive_mode, const uint8_t* loc_mac, const uint8_t* rem_mac, const uint8_t* loc_addr, const uint8_t* rem_addr, int loc_port, int rem_port, :ref:`csap_handle_t`* udp_csap) Create 'udp.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_mac - Local MAC address (or NULL) * - rem_mac - 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) * - loc_port - Local UDP port in network byte order or -1 * - rem_port - Remote 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_udp_ip_eth_csap_create .. _doxid-group__tapi__tad__udp_1ga275218f234546b5d1cfaf5f12601b089: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_udp_ip_eth_csap_create(const char* ta_name, int sid, const char* eth_dev, unsigned int receive_mode, const uint8_t* loc_mac, const uint8_t* rem_mac, int ip_family, const void* loc_addr, const void* rem_addr, int loc_port, int rem_port, :ref:`csap_handle_t`* udp_csap) Create UDP CSAP for IPv4 or IPv6 on Ethernet. .. 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`` * - loc_mac - Local MAC address (or ``NULL``) * - rem_mac - Remote MAC address (or ``NULL``) * - ip_family - Address family * - loc_addr - Local IP address in network byte order (or ``NULL``) * - rem_addr - Remote IP address in network byte order (or ``NULL``) * - loc_port - Local UDP port in network byte order or ``-1`` * - rem_port - Remote UDP port in network byte order or ``-1`` * - udp_csap - Location for the CSAP handle (OUT) .. rubric:: Returns: Zero on success or error code