:orphan: .. index:: pair: group; IGMP .. _doxid-group__tapi__tad__igmp: IGMP ==== .. toctree:: :hidden: enum_tapi_igmp_query_type.rst enum_tapi_igmp_version.rst struct_tapi_igmp3_group_list_s.rst struct_tapi_igmp3_group_record_s.rst struct_tapi_igmp3_src_list_s.rst Overview ~~~~~~~~ Copyright (C) 2004-2022 OKTET Labs Ltd. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // typedefs typedef int :target:`tapi_igmp_msg_type`; typedef struct :ref:`tapi_igmp3_src_list_s` :ref:`tapi_igmp3_src_list_t`; typedef struct :ref:`tapi_igmp3_group_record_s` :ref:`tapi_igmp3_group_record_t`; typedef struct :ref:`tapi_igmp3_group_list_s` :ref:`tapi_igmp3_group_list_t`; // enums enum :ref:`tapi_igmp_query_type`; enum :ref:`tapi_igmp_version`; // structs struct :ref:`tapi_igmp3_group_list_s`; struct :ref:`tapi_igmp3_group_record_s`; struct :ref:`tapi_igmp3_src_list_s`; // global functions void :ref:`tapi_ip4_to_mcast_mac`(in_addr_t ip4_addr, uint8_t* eth_addr); :ref:`te_errno` :ref:`tapi_igmp_add_csap_layer`(:ref:`asn_value`** csap_spec); :ref:`te_errno` :ref:`tapi_igmp2_add_pdu`(:ref:`asn_value`** tmpl_or_ptrn, :ref:`asn_value`** pdu, bool is_pattern, tapi_igmp_msg_type type, int max_resp_time, in_addr_t group_addr); :ref:`te_errno` :ref:`tapi_igmp_ip4_eth_csap_create`(const char* ta_name, int sid, const char* ifname, unsigned int receive_mode, const uint8_t* eth_src, in_addr_t src_addr, :ref:`csap_handle_t`* igmp_csap); :ref:`te_errno` :ref:`tapi_igmp_add_ip4_pdu`(:ref:`asn_value`** tmpl_or_ptrn, :ref:`asn_value`** pdu, bool is_pattern, in_addr_t dst_addr, in_addr_t src_addr); :ref:`te_errno` :ref:`tapi_igmp_add_ip4_pdu_gen`(:ref:`asn_value`** tmpl_or_ptrn, :ref:`asn_value`** pdu, bool is_pattern, in_addr_t dst_addr, in_addr_t src_addr, int ttl, int tos); :ref:`te_errno` :ref:`tapi_igmp_add_ip4_eth_pdu`(:ref:`asn_value`** tmpl_or_ptrn, :ref:`asn_value`** pdu, bool is_pattern, in_addr_t dst_addr, in_addr_t src_addr, uint8_t* eth_src); :ref:`te_errno` :ref:`tapi_igmp_add_ip4_eth_pdu_gen`(:ref:`asn_value`** tmpl_or_ptrn, :ref:`asn_value`** pdu, bool is_pattern, in_addr_t dst_addr, in_addr_t src_addr, uint8_t* eth_src, int ttl, int tos); :ref:`te_errno` :ref:`tapi_igmp1_ip4_eth_send_report`(const char* ta_name, int session, :ref:`csap_handle_t` csap, in_addr_t group_addr, in_addr_t src_addr, uint8_t* eth_src); :ref:`te_errno` :ref:`tapi_igmp2_ip4_eth_send_report`(const char* ta_name, int session, :ref:`csap_handle_t` csap, in_addr_t group_addr, in_addr_t src_addr, uint8_t* eth_src); :ref:`te_errno` :ref:`tapi_igmp2_ip4_eth_send_leave`(const char* ta_name, int session, :ref:`csap_handle_t` csap, in_addr_t group_addr, in_addr_t src_addr, uint8_t* eth_src); :ref:`te_errno` :ref:`tapi_igmp2_ip4_eth_send_query`(const char* ta_name, int session, :ref:`csap_handle_t` csap, int max_resp_time, in_addr_t group_addr, in_addr_t src_addr, bool skip_eth, uint8_t* eth_src); :ref:`te_errno` :ref:`tapi_igmp3_add_report_pdu`(:ref:`asn_value`** tmpl_or_ptrn, :ref:`asn_value`** pdu, bool is_pattern, :ref:`tapi_igmp3_group_list_t`* group_list); :ref:`te_errno` :ref:`tapi_igmp3_ip4_eth_send_report`(const char* ta_name, int session, :ref:`csap_handle_t` csap, :ref:`tapi_igmp3_group_list_t`* group_list, in_addr_t src_addr, uint8_t* eth_src); uint8_t :ref:`tapi_igmp3_max_response_time_to_code`(unsigned max_resp_time); unsigned :ref:`tapi_igmp3_max_response_code_to_time`(uint8_t max_resp_code); uint8_t :ref:`tapi_igmp3_qqi_to_qqic`(unsigned qqi); unsigned :ref:`tapi_igmp3_qqic_to_qqi`(uint8_t qqic); :ref:`te_errno` :ref:`tapi_igmp3_add_query_pdu`(:ref:`asn_value`** tmpl_or_ptrn, :ref:`asn_value`** pdu, bool is_pattern, int max_resp_code, in_addr_t group_addr, int s_flag, int qrv, int qqic, :ref:`tapi_igmp3_src_list_t`* src_list); :ref:`te_errno` :ref:`tapi_igmp3_ip4_eth_send_query`(const char* ta_name, int session, :ref:`csap_handle_t` csap, int max_resp_code, in_addr_t group_addr, int s_flag, int qrv, int qqic, :ref:`tapi_igmp3_src_list_t`* src_list, in_addr_t src_addr, bool skip_eth, uint8_t* eth_src); :ref:`te_errno` :ref:`tapi_igmp3_ip4_eth_send_query_default`(const char* ta_name, int session, :ref:`csap_handle_t` csap, in_addr_t group_addr, :ref:`tapi_igmp3_src_list_t`* src_list, in_addr_t src_addr, bool skip_eth, uint8_t* eth_src); :ref:`te_errno` :ref:`tapi_igmp3_src_list_init`(:ref:`tapi_igmp3_src_list_t`* src_list); void :ref:`tapi_igmp3_src_list_free`(:ref:`tapi_igmp3_src_list_t`* src_list); :ref:`te_errno` :ref:`tapi_igmp3_src_list_add`(:ref:`tapi_igmp3_src_list_t`* src_list, in_addr_t addr); int :ref:`tapi_igmp3_src_list_length`(:ref:`tapi_igmp3_src_list_t`* src_list); :ref:`te_errno` :ref:`tapi_igmp3_src_list_gen_bin`(:ref:`tapi_igmp3_src_list_t`* src_list, void* buf, int buf_size, int* offset); int :ref:`tapi_igmp3_group_record_length`(:ref:`tapi_igmp3_group_record_t`* group_record); :ref:`te_errno` :ref:`tapi_igmp3_group_record_gen_bin`(:ref:`tapi_igmp3_group_record_t`* group_record, void* buf, int buf_size, int* offset); int :ref:`tapi_igmp3_group_list_length`(:ref:`tapi_igmp3_group_list_t`* group_list); :ref:`te_errno` :ref:`tapi_igmp3_group_list_gen_bin`(:ref:`tapi_igmp3_group_list_t`* group_list, void* buf, int buf_size, int* offset); :ref:`te_errno` :ref:`tapi_igmp3_group_record_init`(:ref:`tapi_igmp3_group_record_t`* group_record, int group_type, in_addr_t group_address, void* aux_data, int aux_data_len); void :ref:`tapi_igmp3_group_record_free`(:ref:`tapi_igmp3_group_record_t`* group_record); :ref:`te_errno` :ref:`tapi_igmp3_group_record_add_source`(:ref:`tapi_igmp3_group_record_t`* group_record, in_addr_t src_addr); :ref:`te_errno` :ref:`tapi_igmp3_group_list_init`(:ref:`tapi_igmp3_group_list_t`* group_list); void :ref:`tapi_igmp3_group_list_free`(:ref:`tapi_igmp3_group_list_t`* group_list); :ref:`te_errno` :ref:`tapi_igmp3_group_list_add`(:ref:`tapi_igmp3_group_list_t`* group_list, :ref:`tapi_igmp3_group_record_t`* group_record); :ref:`tapi_igmp3_src_list_t`* :ref:`tapi_igmp3_src_list_new`(:ref:`tapi_igmp3_src_list_t`* src_list, ...); :ref:`tapi_igmp3_group_record_t`* :ref:`tapi_igmp3_group_record_new`(:ref:`tapi_igmp3_group_record_t`* group_record, int group_type, in_addr_t group_address, void* aux_data, int aux_data_len, ...); :ref:`tapi_igmp3_group_list_t`* :ref:`tapi_igmp3_group_list_new`(:ref:`tapi_igmp3_group_list_t`* group_list, ...); // macros #define :target:`IGMP1_SEND_JOIN`(_pco, _csap, _group_addr, _src_addr, _src_mac) #define :target:`IGMP2_SEND_JOIN`(_pco, _csap, _group_addr, _src_addr, _src_mac) #define :target:`IGMP2_SEND_LEAVE`(_pco, _csap, _group_addr, _src_addr, _src_mac) #define :target:`IGMP2_SEND_QUERY`(_pco, _csap, _group_addr, _src_addr, _skip_eth, _src_mac) #define :ref:`IGMP3_GROUP_LIST`(...) #define :ref:`IGMP3_GROUP_RECORD`(_group_type, _group_address, ...) #define :ref:`IGMP3_SEND_ALLOW`(_pco, _csap, _group_addr, _src_addr, _src_mac, _addr1...) #define :ref:`IGMP3_SEND_BLOCK`(_pco, _csap, _group_addr, _src_addr, _src_mac, _addr1...) #define :ref:`IGMP3_SEND_IS_EXCLUDE`(_pco, _csap, _group_addr, _src_addr, _src_mac, ...) #define :ref:`IGMP3_SEND_IS_INCLUDE`(_pco, _csap, _group_addr, _src_addr, _src_mac, ...) #define :ref:`IGMP3_SEND_JOIN`(_pco, _csap, _group_addr, _src_addr, _src_mac) #define :ref:`IGMP3_SEND_LEAVE`(_pco, _csap, _group_addr, _src_addr, _src_mac) #define :ref:`IGMP3_SEND_QUERY`(_pco, _csap, _group_addr, _src_addr, _skip_eth, _src_mac, ...) #define :ref:`IGMP3_SEND_REPORT`(_pco, _csap, _group_list, _src_addr, _src_mac) #define :ref:`IGMP3_SEND_SINGLE_REPORT`(_pco, _csap, _group_type, _group_addr, _src_addr, _src_mac, ...) #define :ref:`IGMP3_SEND_TO_EXCLUDE`(_pco, _csap, _group_addr, _src_addr, _src_mac, ...) #define :ref:`IGMP3_SEND_TO_INCLUDE`(_pco, _csap, _group_addr, _src_addr, _src_mac, ...) #define :ref:`IGMP3_SRC_LIST`(...) #define :ref:`TAPI_IGMP1_TYPE_REPORT` #define :target:`TAPI_IGMP2_TYPE_LEAVE` #define :ref:`TAPI_IGMP2_TYPE_REPORT` #define :ref:`TAPI_IGMP3_GROUP_LIST_SIZE_MAX` #define :target:`TAPI_IGMP3_GROUP_RECORD_HDR_LEN` #define :ref:`TAPI_IGMP3_IP4_TOS_DEFAULT` #define :ref:`TAPI_IGMP3_QUERY_MAX_RESP_TIME_MAX_S` #define :ref:`TAPI_IGMP3_QUERY_QQI_DEFAULT_S` #define :ref:`TAPI_IGMP3_QUERY_QQI_MAX_S` #define :ref:`TAPI_IGMP3_QUERY_QRV_DEFAULT` #define :ref:`TAPI_IGMP3_QUERY_S_DEFAULT` #define :ref:`TAPI_IGMP3_SRC_LIST_SIZE_MAX` #define :ref:`TAPI_IGMP3_TYPE_REPORT` #define :ref:`TAPI_IGMP_IP4_TOS_DEFAULT` #define :ref:`TAPI_IGMP_IP4_TTL_DEFAULT` #define :ref:`TAPI_IGMP_QUERY_MAX_RESP_TIME_DEFAULT_S` #define :ref:`TAPI_IGMP_TYPE_QUERY` #define :ref:`TAPI_MCAST_ADDR_ALL_HOSTS` #define :ref:`TAPI_MCAST_ADDR_ALL_MCR` #define :ref:`TAPI_MCAST_ADDR_ALL_ROUTERS` .. _details-group__tapi__tad__igmp: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved. Typedefs -------- .. index:: pair: typedef; tapi_igmp3_src_list_t .. _doxid-group__tapi__tad__igmp_1ga2a83f98c2163a36c9c6d04a746a943cb: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_igmp3_src_list_s` tapi_igmp3_src_list_t IGMPv3 Source Address List (simple array) storage .. index:: pair: typedef; tapi_igmp3_group_record_t .. _doxid-group__tapi__tad__igmp_1ga0d66d802bb9f175772dbc29e8f1ee682: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_igmp3_group_record_s` tapi_igmp3_group_record_t IGMPv3 Group Record structure .. index:: pair: typedef; tapi_igmp3_group_list_t .. _doxid-group__tapi__tad__igmp_1ga5316792d6ed40e586f2c6536680bc037: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_igmp3_group_list_s` tapi_igmp3_group_list_t IGMPv3 Group Record List storage Global Functions ---------------- .. index:: pair: function; tapi_ip4_to_mcast_mac .. _doxid-group__tapi__tad__igmp_1ga5aa978f2c233af0937724099e5765a85: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_ip4_to_mcast_mac(in_addr_t ip4_addr, uint8_t* eth_addr) Calculate MAC address corresponding to a given IPv4 multicast address. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ip4_addr - IPv4 multicast address. * - eth_addr - Where to save corresponding MAC address. .. index:: pair: function; tapi_igmp_add_csap_layer .. _doxid-group__tapi__tad__igmp_1gafcbe294e82f77a2cb4223babe18725ab: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_igmp_add_csap_layer(:ref:`asn_value`** csap_spec) Add IGMP layer in CSAP specification. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - csap_spec - Location of CSAP specification pointer. * - Status - code. .. index:: pair: function; tapi_igmp2_add_pdu .. _doxid-group__tapi__tad__igmp_1ga9671f36b6576db19a2d572effe6df205: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_igmp2_add_pdu(:ref:`asn_value`** tmpl_or_ptrn, :ref:`asn_value`** pdu, bool is_pattern, tapi_igmp_msg_type type, int max_resp_time, in_addr_t group_addr) Add IGMPv2 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 IGMPv2 message or negative to keep unspecified. * - max_resp_time - IGMP message maximum response time, or negative to keep unspecified. * - group_addr - Multicast Group Address field of IGMPv2 message. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_igmp_ip4_eth_csap_create .. _doxid-group__tapi__tad__igmp_1gab26d53e5c3b02fed77add92b59bef6e4: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_igmp_ip4_eth_csap_create(const char* ta_name, int sid, const char* ifname, unsigned int receive_mode, const uint8_t* eth_src, in_addr_t src_addr, :ref:`csap_handle_t`* igmp_csap) Create 'igmp.ip4.eth' CSAP on the specified Agent .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name * - sid - RCF SID * - ifname - Network interface name * - 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``) * - src_addr - Local IP address in network byte order (or ``NULL``) * - igmp_csap - Location for the CSAP handle (OUT) .. rubric:: Returns: Zero on success or error code .. index:: pair: function; tapi_igmp_add_ip4_pdu .. _doxid-group__tapi__tad__igmp_1ga76081f579b49318d4cfc6ee1dfaf0c8d: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_igmp_add_ip4_pdu(:ref:`asn_value`** tmpl_or_ptrn, :ref:`asn_value`** pdu, bool is_pattern, in_addr_t dst_addr, in_addr_t src_addr) Add IPv4 layer to PDU, used for ppp connections .. 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 * - dst_addr - IPv4 layer Destination Multicast address (also used for generating Ethernet multicast address) * - src_addr - IPv4 layer Source Address field or ``INADDR_ANY`` to keep unspecified. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_igmp_add_ip4_pdu_gen .. _doxid-group__tapi__tad__igmp_1ga3a56dc6a238eccec757c9c659112f20c: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_igmp_add_ip4_pdu_gen(:ref:`asn_value`** tmpl_or_ptrn, :ref:`asn_value`** pdu, bool is_pattern, in_addr_t dst_addr, in_addr_t src_addr, int ttl, int tos) Add IPv4 layer to PDU, used for ppp connections .. 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 * - dst_addr - IPv4 layer Destination Multicast address (also used for generating Ethernet multicast address) * - src_addr - IPv4 layer Source Address field or ``INADDR_ANY`` to keep unspecified. * - ttl - IP TTL * - tos - IP ToS .. rubric:: Returns: Status code. .. index:: pair: function; tapi_igmp_add_ip4_eth_pdu .. _doxid-group__tapi__tad__igmp_1ga9493f1bf3c4b2a618cc7f64a04f9a441: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_igmp_add_ip4_eth_pdu(:ref:`asn_value`** tmpl_or_ptrn, :ref:`asn_value`** pdu, bool is_pattern, in_addr_t dst_addr, in_addr_t src_addr, uint8_t* eth_src) Add IPv4.Eth layers to PDU Destination address Ethernet layers is calculated from ``dst_address`` value. .. 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 * - dst_addr - IPv4 layer Destination Multicast address (also used for generating Ethernet multicast address) * - src_addr - IPv4 layer Source Address field or ``INADDR_ANY`` to keep unspecified. * - eth_src - Ethernet layer Source Address field or ``NULL`` to keep unspecified. * - tos - IP ToS field .. rubric:: Returns: Status code. .. index:: pair: function; tapi_igmp_add_ip4_eth_pdu_gen .. _doxid-group__tapi__tad__igmp_1gae98003969f00bc3f56e862cf240ed69d: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_igmp_add_ip4_eth_pdu_gen(:ref:`asn_value`** tmpl_or_ptrn, :ref:`asn_value`** pdu, bool is_pattern, in_addr_t dst_addr, in_addr_t src_addr, uint8_t* eth_src, int ttl, int tos) Add IPv4.Eth layers to PDU, Destination address Ethernet layers is calculated from ``dst_address`` value. .. 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 * - dst_addr - IPv4 layer Destination Multicast address (also used for generating Ethernet multicast address) * - src_addr - IPv4 layer Source Address field or ``INADDR_ANY`` to keep unspecified. * - eth_src - Ethernet layer Source Address field or ``NULL`` to keep unspecified. * - ttl - IP TTL field * - tos - IP ToS field .. rubric:: Returns: Status code. .. index:: pair: function; tapi_igmp1_ip4_eth_send_report .. _doxid-group__tapi__tad__igmp_1ga85b3e020d9cc272681041b393292308f: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_igmp1_ip4_eth_send_report(const char* ta_name, int session, :ref:`csap_handle_t` csap, in_addr_t group_addr, in_addr_t src_addr, uint8_t* eth_src) Send IGMPv1 report message .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name * - session - RCF SID * - csap - igmp.ip4.eth CSAP handle to send IGMP message through * - group_addr - Multicast Group Address field of IGMPv2 message. * - src_addr - IPv4 layer Source Address field or ``INADDR_ANY`` to keep unspecified. * - eth_src - Ethernet layer Source Address field or ``NULL`` to keep unspecified. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_igmp2_ip4_eth_send_report .. _doxid-group__tapi__tad__igmp_1ga3e7030a1f147702ff1ba5701a3a60d29: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_igmp2_ip4_eth_send_report(const char* ta_name, int session, :ref:`csap_handle_t` csap, in_addr_t group_addr, in_addr_t src_addr, uint8_t* eth_src) Send IGMPv2 report message .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name * - session - RCF SID * - csap - igmp.ip4.eth CSAP handle to send IGMP message through * - group_addr - Multicast Group Address field of IGMPv2 message. * - src_addr - IPv4 layer Source Address field or ``INADDR_ANY`` to keep unspecified. * - eth_src - Ethernet layer Source Address field or ``NULL`` to keep unspecified. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_igmp2_ip4_eth_send_leave .. _doxid-group__tapi__tad__igmp_1gad8f4dbc07c669de6b8d6ddff9d1ea4d9: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_igmp2_ip4_eth_send_leave(const char* ta_name, int session, :ref:`csap_handle_t` csap, in_addr_t group_addr, in_addr_t src_addr, uint8_t* eth_src) Send IGMPv2 Group Membership Leave message .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name * - session - RCF SID * - csap - igmp.ip4.eth CSAP handle to send IGMP message through * - group_addr - Multicast Group Address field of IGMPv2 message. * - src_addr - IPv4 layer Source Address field or ``INADDR_ANY`` to keep unspecified. * - eth_src - Ethernet layer Source Address field or ``NULL`` to keep unspecified. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_igmp2_ip4_eth_send_query .. _doxid-group__tapi__tad__igmp_1gae7bb50ce9ec4ac534fbb566af4aa7c7d: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_igmp2_ip4_eth_send_query(const char* ta_name, int session, :ref:`csap_handle_t` csap, int max_resp_time, in_addr_t group_addr, in_addr_t src_addr, bool skip_eth, uint8_t* eth_src) Send IGMPv2 Query message .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name * - session - RCF SID * - csap - igmp.ip4.eth CSAP handle to send IGMP message through * - max_resp_time - IGMP message maximum response time, or negative to keep unspecified. * - group_addr - Multicast Group Address field of IGMPv2 message. For General Query should be 0.0.0.0 (``INADDR_ANY``) * - src_addr - IPv4 layer Source Address field or ``INADDR_ANY`` to keep unspecified. * - skip_eth - Do not add ``eth_src`` * - eth_src - Ethernet layer Source Address field or ``NULL`` to keep unspecified. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_igmp3_add_report_pdu .. _doxid-group__tapi__tad__igmp_1ga46fbd6c04f5c554d2f9a9b8783b8dfdf: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_igmp3_add_report_pdu(:ref:`asn_value`** tmpl_or_ptrn, :ref:`asn_value`** pdu, bool is_pattern, :ref:`tapi_igmp3_group_list_t`* group_list) Add IGMPv3 Report 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 * - group_list - List of Group Records to be sent in this PDU .. rubric:: Returns: Status code. .. index:: pair: function; tapi_igmp3_ip4_eth_send_report .. _doxid-group__tapi__tad__igmp_1ga96d7e902ae1284fe9adb17e5102e4426: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_igmp3_ip4_eth_send_report(const char* ta_name, int session, :ref:`csap_handle_t` csap, :ref:`tapi_igmp3_group_list_t`* group_list, in_addr_t src_addr, uint8_t* eth_src) Send IGMPv3 Group Membership report message .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name * - session - RCF SID * - csap - igmp.ip4.eth CSAP handle to send IGMP message through * - group_list - Group Record List to be sent * - src_addr - IPv4 layer Source Address field or ``INADDR_ANY`` to keep unspecified. * - eth_src - Ethernet layer Source Address field or ``NULL`` to keep unspecified. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_igmp3_max_response_time_to_code .. _doxid-group__tapi__tad__igmp_1ga1ded8147b874c59b60a8b3d5fba3ee3d: .. ref-code-block:: cpp :class: doxyrest-title-code-block uint8_t tapi_igmp3_max_response_time_to_code(unsigned max_resp_time) Convert Max Response Time to IGMPv3 Max Response Code. See RFC 3376, section 4.1.1. Predefined ``max_resp_time`` values: :ref:`TAPI_IGMP_QUERY_MAX_RESP_TIME_DEFAULT_S ` :ref:`TAPI_IGMP3_QUERY_MAX_RESP_TIME_MAX_S ` .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - max_resp_time - Max Response Time in seconds. .. rubric:: Returns: Max Response Code suitable for writing to IGMPv3 Query message. .. index:: pair: function; tapi_igmp3_max_response_code_to_time .. _doxid-group__tapi__tad__igmp_1ga277fa23b0bf4067dbd9eca737aeb36a3: .. ref-code-block:: cpp :class: doxyrest-title-code-block unsigned tapi_igmp3_max_response_code_to_time(uint8_t max_resp_code) Convert IGMPv3 Max Response Code to Max Response Time. See RFC 3376, section 4.1.1. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - max_resp_code - Max Response Code in exponential form from IGMPv3 Query message. .. rubric:: Returns: Max Response Time in seconds. .. index:: pair: function; tapi_igmp3_qqi_to_qqic .. _doxid-group__tapi__tad__igmp_1gafb8e5aece09c5f476008f1535216f084: .. ref-code-block:: cpp :class: doxyrest-title-code-block uint8_t tapi_igmp3_qqi_to_qqic(unsigned qqi) Convert Querier's Query Interval to Querier's Query Interval Code. See RFC 3376, section 4.1.7. Predefined ``qqi`` values: :ref:`TAPI_IGMP3_QUERY_QQI_DEFAULT_S ` :ref:`TAPI_IGMP3_QUERY_QQI_MAX_S ` .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - qqi - Querier's Query Interval (QQI) in seconds. .. rubric:: Returns: Querier's Query Interval Code (QQIC) suitable for writing to IGMPv3 Query message. .. index:: pair: function; tapi_igmp3_qqic_to_qqi .. _doxid-group__tapi__tad__igmp_1gac007e675f062bc981e59bf7037be46da: .. ref-code-block:: cpp :class: doxyrest-title-code-block unsigned tapi_igmp3_qqic_to_qqi(uint8_t qqic) Convert Querier's Query Interval Code to Querier's Query Interval. See RFC 3376, section 4.1.7. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - qqic - Querier's Query Interval Code (QQIC) in exponential form from IGMPv3 Query message. .. rubric:: Returns: Querier's Query Interval (QQI) in seconds. .. index:: pair: function; tapi_igmp3_add_query_pdu .. _doxid-group__tapi__tad__igmp_1gaa13f99d356305de973d2f00f3b47c7ed: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_igmp3_add_query_pdu(:ref:`asn_value`** tmpl_or_ptrn, :ref:`asn_value`** pdu, bool is_pattern, int max_resp_code, in_addr_t group_addr, int s_flag, int qrv, int qqic, :ref:`tapi_igmp3_src_list_t`* src_list) Add IGMPv3 Query 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 * - max_resp_code - IGMP message maximum response code, or negative to keep unspecified. * - group_addr - Multicast Group Address field of IGMPv3 Query message. * - s_flag - S Flag (Suppress Router-Side Processing) field of IGMPv3 Query message. * - qrv - QRV (Querier's Robustness Variable) field of IGMPv3 Query message. * - qqic - QQIC (Querier's Query Interval Code) field of IGMPv3 Query message. * - src_list - List of source addresses to be sent in this PDU, or ``NULL`` .. rubric:: Returns: Status code. .. index:: pair: function; tapi_igmp3_ip4_eth_send_query .. _doxid-group__tapi__tad__igmp_1ga82dd2ff88ad996fb9e38b9b2cad2ab68: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_igmp3_ip4_eth_send_query(const char* ta_name, int session, :ref:`csap_handle_t` csap, int max_resp_code, in_addr_t group_addr, int s_flag, int qrv, int qqic, :ref:`tapi_igmp3_src_list_t`* src_list, in_addr_t src_addr, bool skip_eth, uint8_t* eth_src) Send IGMPv3 Group Membership Query message To specify the case of General Query, ``group_addr`` should be ``INADDR_ANY`` and message will be sent to ``ALL_HOSTS`` (224.0.0.1) .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name * - session - RCF SID * - csap - igmp.ip4.eth CSAP handle to send IGMP message through * - max_resp_code - IGMP message maximum response code, or negative to keep unspecified. * - group_addr - Multicast Group Address field of IGMPv3 Query message. * - s_flag - S Flag (Suppress Router-Side Processing) field of IGMPv3 Query message. * - qrv - QRV (Querier's Robustness Variable) field of IGMPv3 Query message. * - qqic - QQIC (Querier's Query Interval Code) field of IGMPv3 Query message. * - src_list - List of source addresses to be sent in this PDU, or ``NULL`` * - src_addr - IPv4 layer Source Address field or ``INADDR_ANY`` to keep unspecified. * - skip_eth - Do not add ``eth_src`` * - eth_src - Ethernet layer Source Address field or ``NULL`` to keep unspecified. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_igmp3_ip4_eth_send_query_default .. _doxid-group__tapi__tad__igmp_1ga9eb7a4d02a67a0a8a92657fb80b930b8: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_igmp3_ip4_eth_send_query_default(const char* ta_name, int session, :ref:`csap_handle_t` csap, in_addr_t group_addr, :ref:`tapi_igmp3_src_list_t`* src_list, in_addr_t src_addr, bool skip_eth, uint8_t* eth_src) Send IGMPv3 Group Membership Query message with default timeouts and flags. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name. * - session - RCF SID. * - csap - igmp.ip4.eth CSAP handle to send IGMP message through. * - group_addr - Multicast Group Address field of IGMPv3 Query message. * - src_list - List of source addresses to be sent in this PDU, or ``NULL``. * - src_addr - IPv4 layer Source Address field or ``INADDR_ANY`` to keep unspecified. * - skip_eth - Do not add ``eth_src``. * - eth_src - Ethernet layer Source Address field or ``NULL`` to keep unspecified. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_igmp3_src_list_init .. _doxid-group__tapi__tad__igmp_1ga254c22b33fc66856552e4a988ded4e09: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_igmp3_src_list_init(:ref:`tapi_igmp3_src_list_t`* src_list) Initialise Source Address List instance .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - src_list - Pointer to Source Address List to initialise with default values .. rubric:: Returns: Status code. .. index:: pair: function; tapi_igmp3_src_list_free .. _doxid-group__tapi__tad__igmp_1gaa82abd22292644cd6691786f14dd5cfd: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_igmp3_src_list_free(:ref:`tapi_igmp3_src_list_t`* src_list) Free resources allocated by Source Address List instance .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - src_list - Pointer to Source Address List to finalise .. rubric:: Returns: N/A .. index:: pair: function; tapi_igmp3_src_list_add .. _doxid-group__tapi__tad__igmp_1ga6d272587983244a095640e10ae217090: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_igmp3_src_list_add(:ref:`tapi_igmp3_src_list_t`* src_list, in_addr_t addr) Add source address to the list .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - src_list - Source Address List to add to * - addr - IPv4 address to add .. rubric:: Returns: Status code. .. index:: pair: function; tapi_igmp3_src_list_length .. _doxid-group__tapi__tad__igmp_1ga1a1c90c86be22c6c252fb0a4a4f86616: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_igmp3_src_list_length(:ref:`tapi_igmp3_src_list_t`* src_list) Calculate the binary length of the Source Address List stored in IGMPv3 message .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - src_list - Source Address List .. rubric:: Returns: Length in bytes. .. index:: pair: function; tapi_igmp3_src_list_gen_bin .. _doxid-group__tapi__tad__igmp_1ga90cfc4029bc54272faa46b8b21c0685b: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_igmp3_src_list_gen_bin(:ref:`tapi_igmp3_src_list_t`* src_list, void* buf, int buf_size, int* offset) Pack the source list to store in IGMPv3 message .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - src_list - Source Address List to pack * - buf - Buffer to pack the Source Address List at * - buf_size - Size of pre-allocated buffer * - offset - Buffer offset to start packing from .. rubric:: Returns: Status code. .. index:: pair: function; tapi_igmp3_group_record_length .. _doxid-group__tapi__tad__igmp_1ga365ffe30fa18f740e9e9f8b39c941750: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_igmp3_group_record_length(:ref:`tapi_igmp3_group_record_t`* group_record) Calculate the binary length of the Group Record stored in IGMPv3 message .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - group_record - Group Record to pack .. rubric:: Returns: Length in bytes. .. index:: pair: function; tapi_igmp3_group_record_gen_bin .. _doxid-group__tapi__tad__igmp_1ga04da468e2dfceb6f11d219fa77a58e47: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_igmp3_group_record_gen_bin(:ref:`tapi_igmp3_group_record_t`* group_record, void* buf, int buf_size, int* offset) Pack the Group Record structure with Source Address List to store in IGMPv3 message .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - group_record - Group Record to pack * - buf - Buffer to pack the Group Record List at * - buf_size - Size of pre-allocated buffer * - offset - Buffer offset to start packing from .. rubric:: Returns: Status code. .. index:: pair: function; tapi_igmp3_group_list_length .. _doxid-group__tapi__tad__igmp_1ga1a8be996052d8c0f186b3266ac9db137: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_igmp3_group_list_length(:ref:`tapi_igmp3_group_list_t`* group_list) Calculate the binary length of the Group Record List packed in IGMPv3 message .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - group_list - Group Record List to pack .. rubric:: Returns: Length in bytes. .. index:: pair: function; tapi_igmp3_group_list_gen_bin .. _doxid-group__tapi__tad__igmp_1gadaf61573dca48d36b77d2a0bf7f21e6b: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_igmp3_group_list_gen_bin(:ref:`tapi_igmp3_group_list_t`* group_list, void* buf, int buf_size, int* offset) Pack the Group Record List to store in IGMPv3 message .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - group_list - Group Record List to pack * - buf - Buffer to pack the Group Record List at * - buf_size - Size of pre-allocated buffer * - offset - Buffer offset to start packing from .. rubric:: Returns: Status code. .. index:: pair: function; tapi_igmp3_group_record_init .. _doxid-group__tapi__tad__igmp_1ga7b87458168813f7f5d1c6c5dd44070ad: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_igmp3_group_record_init(:ref:`tapi_igmp3_group_record_t`* group_record, int group_type, in_addr_t group_address, void* aux_data, int aux_data_len) Initialise pre-allocated structure of Group Record with default values .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - group_record - Group Record to initialise * - group_type - Type of the Group Record * - group_address - Multicast Group Address * - aux_data - Pointer to auxiliary data to be packed into the record group. * - aux_data_len - Length of the auxiliary data in 32-bit words .. rubric:: Returns: Status code. .. index:: pair: function; tapi_igmp3_group_record_free .. _doxid-group__tapi__tad__igmp_1gae498d6133d1a7373ea2f9abb1d79a2fa: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_igmp3_group_record_free(:ref:`tapi_igmp3_group_record_t`* group_record) Free system resources allocated by group_record .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - group_record - Group Record to free .. rubric:: Returns: Status code. .. index:: pair: function; tapi_igmp3_group_record_add_source .. _doxid-group__tapi__tad__igmp_1ga894742112ab6e1715a4a3c15a1374361: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_igmp3_group_record_add_source(:ref:`tapi_igmp3_group_record_t`* group_record, in_addr_t src_addr) Add source address to the group_record .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - group_record - Group Record to add to * - src_addr - IPv4 source address to add .. rubric:: Returns: Status code. .. index:: pair: function; tapi_igmp3_group_list_init .. _doxid-group__tapi__tad__igmp_1ga8c3a2fc9e30ef65ca14d092440a915a9: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_igmp3_group_list_init(:ref:`tapi_igmp3_group_list_t`* group_list) Initialise the Group Record List with initial values .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - group_list - Group Record List structure to initialise .. rubric:: Returns: Status code. .. index:: pair: function; tapi_igmp3_group_list_free .. _doxid-group__tapi__tad__igmp_1gaaf42086afa3adaa6f59498dcc84fb6ff: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_igmp3_group_list_free(:ref:`tapi_igmp3_group_list_t`* group_list) Free system resources allocated by Group Record List .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - group_list - Group Record List to free .. rubric:: Returns: Status code. .. index:: pair: function; tapi_igmp3_group_list_add .. _doxid-group__tapi__tad__igmp_1ga0e55bf4547dc9912197c274e25c86c4c: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_igmp3_group_list_add(:ref:`tapi_igmp3_group_list_t`* group_list, :ref:`tapi_igmp3_group_record_t`* group_record) Add Group Record to the Group Record List .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - group_list - Group Record List to add to * - group_record - Group Record structure to add .. rubric:: Returns: Status code. .. index:: pair: function; tapi_igmp3_src_list_new .. _doxid-group__tapi__tad__igmp_1ga7036ae1eb5300e7652ffdb2b5b2926bc: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`tapi_igmp3_src_list_t`* tapi_igmp3_src_list_new(:ref:`tapi_igmp3_src_list_t`* src_list, ...) Allocate, initialise and fill source list structure .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - src_list - Source list to initialise and fill Memory allocation will be skipped if this parameter is not ``NULL`` * - ... - List of source addresses to be added to the list (list should end with 0 value (``INADDR_ANY``)) .. rubric:: Returns: Initialised source list, or ``NULL`` if failed. .. index:: pair: function; tapi_igmp3_group_record_new .. _doxid-group__tapi__tad__igmp_1gac593864ec1cd995796f0246bdc03ebe9: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`tapi_igmp3_group_record_t`* tapi_igmp3_group_record_new(:ref:`tapi_igmp3_group_record_t`* group_record, int group_type, in_addr_t group_address, void* aux_data, int aux_data_len, ...) Allocate, initialise and fill Group Record structure .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - group_record - Group Record to initialise and fill Memory allocation will be skipped if this parameter is not ``NULL`` * - group_type - Type of the Group Record * - group_address - Multicast Group Address * - aux_data - Pointer to auxiliary data to be packed into the record group. * - aux_data_len - Length of the auxiliary data in 32-bit words * - ... - List of source addresses to be added to the record (list should end with 0 value (``INADDR_ANY``)) .. rubric:: Returns: Initialised Group Record, or ``NULL`` if failed. .. index:: pair: function; tapi_igmp3_group_list_new .. _doxid-group__tapi__tad__igmp_1gae7595010eb010ede9f07e17abdbbe640: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`tapi_igmp3_group_list_t`* tapi_igmp3_group_list_new(:ref:`tapi_igmp3_group_list_t`* group_list, ...) Allocate, initialise and fill Group Record List structure .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - group_list - Group Record List to initialise and fill Memory allocation will be skipped if this parameter is not ``NULL`` * - ... - List of Group Records to be added to the list (list should end with ``NULL`` value) .. rubric:: Returns: Initialised Group Record List, or ``NULL`` if failed. Macros ------ .. index:: pair: define; IGMP3_GROUP_LIST .. _doxid-group__tapi__tad__igmp_1ga596fa81e1940197e7784fd61964ec257: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define IGMP3_GROUP_LIST(...) Allocate, initialise and fill Group Record List structure. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ... - List of Group Records (tapi_igmp3_group_record_t \*) to be added to the list. May be omitted. .. rubric:: Returns: Initialised Group Record List. .. index:: pair: define; IGMP3_GROUP_RECORD .. _doxid-group__tapi__tad__igmp_1ga9d3e1e2fd4826d918d0061e8b9c8c47d: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define IGMP3_GROUP_RECORD(_group_type, _group_address, ...) Allocate, initialise and fill Group Record structure. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _group_type - Type of the Group Record. * - _group_address - Multicast Group Address. * - ... - List of source addresses (in_addr_t) to be added to the record. May be omitted. .. rubric:: Returns: Initialised Group Record. .. index:: pair: define; IGMP3_SEND_ALLOW .. _doxid-group__tapi__tad__igmp_1gaec27970a237f54df7cb7e32854b1903a: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define IGMP3_SEND_ALLOW(_pco, _csap, _group_addr, _src_addr, _src_mac, _addr1...) Send IGMPv3 report with one Group Record to allow multicast traffic. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _pco - RPC server. * - _csap - igmp.ip4.eth CSAP handle to send IGMP message through. * - _group_addr - Multicast Group Address. * - _src_addr - IPv4 layer Source Address field or ``INADDR_ANY`` to keep unspecified. * - _src_mac - Ethernet layer Source Address field or ``NULL`` to keep unspecified. * - _addr1 - First source address to be added to the record. * - ... - List of source addresses to be added to the record. May be omitted. .. index:: pair: define; IGMP3_SEND_BLOCK .. _doxid-group__tapi__tad__igmp_1gabc503a142ed0efa8e29933ec3b6f7aae: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define IGMP3_SEND_BLOCK(_pco, _csap, _group_addr, _src_addr, _src_mac, _addr1...) Send IGMPv3 report with one Group Record to block multicast traffic. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _pco - RPC server. * - _csap - igmp.ip4.eth CSAP handle to send IGMP message through. * - _group_addr - Multicast Group Address. * - _src_addr - IPv4 layer Source Address field or ``INADDR_ANY`` to keep unspecified. * - _src_mac - Ethernet layer Source Address field or ``NULL`` to keep unspecified. * - _addr1 - First source address to be added to the record. * - ... - List of source addresses to be added to the record. May be omitted. .. index:: pair: define; IGMP3_SEND_IS_EXCLUDE .. _doxid-group__tapi__tad__igmp_1ga94f84d9d1821766c1129fdaf2a2d2a39: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define IGMP3_SEND_IS_EXCLUDE(_pco, _csap, _group_addr, _src_addr, _src_mac, ...) Send IGMPv3 report with one Group Record of MODE_IS_EXCLUDE type. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _pco - RPC server. * - _csap - igmp.ip4.eth CSAP handle to send IGMP message through. * - _group_addr - Multicast Group Address. * - _src_addr - IPv4 layer Source Address field or ``INADDR_ANY`` to keep unspecified. * - _src_mac - Ethernet layer Source Address field or ``NULL`` to keep unspecified. * - ... - List of source addresses to be added to the record. May be omitted. .. index:: pair: define; IGMP3_SEND_IS_INCLUDE .. _doxid-group__tapi__tad__igmp_1ga149cafecedecccb97a1e38d448db5f78: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define IGMP3_SEND_IS_INCLUDE(_pco, _csap, _group_addr, _src_addr, _src_mac, ...) Send IGMPv3 report with one Group Record of MODE_IS_INCLUDE type. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _pco - RPC server. * - _csap - igmp.ip4.eth CSAP handle to send IGMP message through. * - _group_addr - Multicast Group Address. * - _src_addr - IPv4 layer Source Address field or ``INADDR_ANY`` to keep unspecified. * - _src_mac - Ethernet layer Source Address field or ``NULL`` to keep unspecified. * - ... - List of source addresses to be added to the record. May be omitted. .. index:: pair: define; IGMP3_SEND_JOIN .. _doxid-group__tapi__tad__igmp_1ga38ebad340b77d8c4b1ab68e37b979858: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define IGMP3_SEND_JOIN(_pco, _csap, _group_addr, _src_addr, _src_mac) Send IGMPv3 report with one Group Record to receive multicast traffic from any source (same as IGMPv2 Membership Report). .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _pco - RPC server. * - _csap - igmp.ip4.eth CSAP handle to send IGMP message through. * - _group_addr - Multicast Group Address. * - _src_addr - IPv4 layer Source Address field or ``INADDR_ANY`` to keep unspecified. * - _src_mac - Ethernet layer Source Address field or ``NULL`` to keep unspecified. .. index:: pair: define; IGMP3_SEND_LEAVE .. _doxid-group__tapi__tad__igmp_1gad216fe34d69f90a16f672f9b563450e9: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define IGMP3_SEND_LEAVE(_pco, _csap, _group_addr, _src_addr, _src_mac) Send IGMPv3 report with one Group Record to block multicast traffic from any source (same as IGMPv2 Leave Group). .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _pco - RPC server. * - _csap - igmp.ip4.eth CSAP handle to send IGMP message through. * - _group_addr - Multicast Group Address. * - _src_addr - IPv4 layer Source Address field or ``INADDR_ANY`` to keep unspecified. * - _src_mac - Ethernet layer Source Address field or ``NULL`` to keep unspecified. .. index:: pair: define; IGMP3_SEND_QUERY .. _doxid-group__tapi__tad__igmp_1ga4e85e0183cc486322390227a7f2faa0a: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define IGMP3_SEND_QUERY(_pco, _csap, _group_addr, _src_addr, _skip_eth, _src_mac, ...) Send IGMPv3 query. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _pco - RPC server. * - _csap - igmp.ip4.eth CSAP handle to send IGMP message through. * - _group_addr - Multicast Group Address field of IGMPv3 Query message. * - _src_addr - IPv4 layer Source Address field or ``INADDR_ANY`` to keep unspecified. * - _skip_eth - Do not add ``_src_mac`` * - _src_mac - Ethernet layer Source Address field or ``NULL`` to keep unspecified. * - ... - List of source addresses to be added to the record. May be omitted. .. index:: pair: define; IGMP3_SEND_REPORT .. _doxid-group__tapi__tad__igmp_1gae47b5680c1945478ffb01a62762bc3e8: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define IGMP3_SEND_REPORT(_pco, _csap, _group_list, _src_addr, _src_mac) Send IGMPv3 report and free group list. ``_group_list`` will be freed after sending. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _pco - RPC server. * - _csap - igmp.ip4.eth CSAP handle to send IGMP message through. * - _group_list - Group Record List to be sent. * - _src_addr - IPv4 layer Source Address field or ``INADDR_ANY`` to keep unspecified. * - _src_mac - Ethernet layer Source Address field or ``NULL`` to keep unspecified. .. index:: pair: define; IGMP3_SEND_SINGLE_REPORT .. _doxid-group__tapi__tad__igmp_1ga7d8a4079a0b972c083d3f1b20d48c61a: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define IGMP3_SEND_SINGLE_REPORT(_pco, _csap, _group_type, _group_addr, _src_addr, _src_mac, ...) Send IGMPv3 report with one multicast Group Record. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _pco - RPC server. * - _csap - igmp.ip4.eth CSAP handle to send IGMP message through. * - _group_type - Type of the Group Record. * - _group_addr - Multicast Group Address. * - _src_addr - IPv4 layer Source Address field or ``INADDR_ANY`` to keep unspecified. * - _src_mac - Ethernet layer Source Address field or ``NULL`` to keep unspecified. * - ... - List of source addresses to be added to the record. May be omitted. .. index:: pair: define; IGMP3_SEND_TO_EXCLUDE .. _doxid-group__tapi__tad__igmp_1ga15a06829ec4f9157bac8630610474b2c: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define IGMP3_SEND_TO_EXCLUDE(_pco, _csap, _group_addr, _src_addr, _src_mac, ...) Send IGMPv3 report with one Group Record of CHANGE_TO_EXCLUDE type. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _pco - RPC server. * - _csap - igmp.ip4.eth CSAP handle to send IGMP message through. * - _group_addr - Multicast Group Address. * - _src_addr - IPv4 layer Source Address field or ``INADDR_ANY`` to keep unspecified. * - _src_mac - Ethernet layer Source Address field or ``NULL`` to keep unspecified. * - ... - List of source addresses to be added to the record. May be omitted. .. index:: pair: define; IGMP3_SEND_TO_INCLUDE .. _doxid-group__tapi__tad__igmp_1ga54f232a1e499f2f9c7f5c7eca5f8c6f1: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define IGMP3_SEND_TO_INCLUDE(_pco, _csap, _group_addr, _src_addr, _src_mac, ...) Send IGMPv3 report with one Group Record of CHANGE_TO_INCLUDE type. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _pco - RPC server. * - _csap - igmp.ip4.eth CSAP handle to send IGMP message through. * - _group_addr - Multicast Group Address. * - _src_addr - IPv4 layer Source Address field or ``INADDR_ANY`` to keep unspecified. * - _src_mac - Ethernet layer Source Address field or ``NULL`` to keep unspecified. * - ... - List of source addresses to be added to the record. May be omitted. .. index:: pair: define; IGMP3_SRC_LIST .. _doxid-group__tapi__tad__igmp_1gaf7328a21fc7ace92e77aa3de482e86e6: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define IGMP3_SRC_LIST(...) Allocate, initialise and fill Source Address List structure. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ... - List of source addresses (in_addr_t) to be added to the list. .. rubric:: Returns: Initialised Source Address List. May be omitted. .. index:: pair: define; TAPI_IGMP1_TYPE_REPORT .. _doxid-group__tapi__tad__igmp_1ga2d04c95a8701ea6bdf33565098ffe39b: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_IGMP1_TYPE_REPORT IGMPv1 Membership report .. index:: pair: define; TAPI_IGMP2_TYPE_REPORT .. _doxid-group__tapi__tad__igmp_1gae8c448d5497c0f6274c0ebdf4ccec28b: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_IGMP2_TYPE_REPORT IGMPv2 Membership report Group Leave message .. index:: pair: define; TAPI_IGMP3_GROUP_LIST_SIZE_MAX .. _doxid-group__tapi__tad__igmp_1gaddf4dd16af42b75f494e004001355160: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_IGMP3_GROUP_LIST_SIZE_MAX Maximum number of Group Records in list (see RFC 3376) .. index:: pair: define; TAPI_IGMP3_IP4_TOS_DEFAULT .. _doxid-group__tapi__tad__igmp_1gafa6500c280e341bee27610b46f98a186: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_IGMP3_IP4_TOS_DEFAULT Default ToS for IGMPv3 messages is 0xc0 .. index:: pair: define; TAPI_IGMP3_QUERY_MAX_RESP_TIME_MAX_S .. _doxid-group__tapi__tad__igmp_1gac45cedfc4fcdf430aae2e54f77cc1300: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_IGMP3_QUERY_MAX_RESP_TIME_MAX_S Max Response Time maximum value in seconds for IGMPv3 Query message (see RFC 3376, 4.1.1) .. index:: pair: define; TAPI_IGMP3_QUERY_QQI_DEFAULT_S .. _doxid-group__tapi__tad__igmp_1ga71009029f90c175745f42bf74fc411ac: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_IGMP3_QUERY_QQI_DEFAULT_S Querier's Query Interval (QQI) default value in seconds, can be converted to Querier's Query Interval Code (QQIC)(see RFC 3376, 4.1.7) .. index:: pair: define; TAPI_IGMP3_QUERY_QQI_MAX_S .. _doxid-group__tapi__tad__igmp_1ga7f6ca2f26b6e2370fa3ef3efee743e00: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_IGMP3_QUERY_QQI_MAX_S Querier's Query Interval (QQI) maximum value (see RFC 3376, 4.1.7) .. index:: pair: define; TAPI_IGMP3_QUERY_QRV_DEFAULT .. _doxid-group__tapi__tad__igmp_1ga3b9be43e5cffaa53dec6ddc53b9bb50e: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_IGMP3_QUERY_QRV_DEFAULT Querier's Robustness Variable (see RFC 3376, 4.1.6) .. index:: pair: define; TAPI_IGMP3_QUERY_S_DEFAULT .. _doxid-group__tapi__tad__igmp_1gac58b5362e6262622e985a48143c55d29: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_IGMP3_QUERY_S_DEFAULT Suppress Router-Side Processing flag (see RFC 3376, 4.1.5) .. index:: pair: define; TAPI_IGMP3_SRC_LIST_SIZE_MAX .. _doxid-group__tapi__tad__igmp_1ga529d8f994bc75c068581eda5a07c5ffc: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_IGMP3_SRC_LIST_SIZE_MAX Maximum number of Source Addresses in list (see RFC 3376) .. index:: pair: define; TAPI_IGMP3_TYPE_REPORT .. _doxid-group__tapi__tad__igmp_1ga0a365802eb91fff6271857ffc040ae25: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_IGMP3_TYPE_REPORT IGMPv3 Membership report .. index:: pair: define; TAPI_IGMP_IP4_TOS_DEFAULT .. _doxid-group__tapi__tad__igmp_1ga236ea903518b5dd85ff09331058dd4ba: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_IGMP_IP4_TOS_DEFAULT Default ToS for IGMPv2 messages is not stricted to any value .. index:: pair: define; TAPI_IGMP_IP4_TTL_DEFAULT .. _doxid-group__tapi__tad__igmp_1gab70fbb6615591ad6eb9d1778716bb741: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_IGMP_IP4_TTL_DEFAULT Default TTL for IGMP messages is 1 .. index:: pair: define; TAPI_IGMP_QUERY_MAX_RESP_TIME_DEFAULT_S .. _doxid-group__tapi__tad__igmp_1gaec5c4792500c6df140ae9fe8df0a363c: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_IGMP_QUERY_MAX_RESP_TIME_DEFAULT_S Max Response Time default value in seconds, can be converted to Max Resp Code (see RFC 3376/RFC 2236, 8.3) .. index:: pair: define; TAPI_IGMP_TYPE_QUERY .. _doxid-group__tapi__tad__igmp_1gaf5426d3827f4a575925b4183d5365c4a: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_IGMP_TYPE_QUERY IGMP message types definition General/Group Query message .. index:: pair: define; TAPI_MCAST_ADDR_ALL_HOSTS .. _doxid-group__tapi__tad__igmp_1ga4abd7169cfe219f72c38cc35910495d6: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_MCAST_ADDR_ALL_HOSTS IPv4 Multicast Address of All-Hosts group: 224.0.0.1 .. index:: pair: define; TAPI_MCAST_ADDR_ALL_MCR .. _doxid-group__tapi__tad__igmp_1gacefbe31d337d07d50ec4a9f63ebabcc2: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_MCAST_ADDR_ALL_MCR IPv4 Multicast Address of All-Multicast-Routers IGMPv3 group: 224.0.0.22 .. index:: pair: define; TAPI_MCAST_ADDR_ALL_ROUTERS .. _doxid-group__tapi__tad__igmp_1ga8bf407c9520ad401f096cd09303b1d3d: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_MCAST_ADDR_ALL_ROUTERS IPv4 Multicast Address of All-Routers group: 224.0.0.2