:orphan: .. index:: pair: group; ATM .. _doxid-group__tapi__tad__atm: ATM === .. toctree:: :hidden: Overview ~~~~~~~~ Declarations of API for TAPI ATM. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // global functions :ref:`te_errno` :ref:`tapi_atm_add_csap_layer`(:ref:`asn_value`** csap_spec, const char* device, :ref:`ndn_atm_type` type, const uint16_t* vpi, const uint16_t* vci, bool* congestion, bool* clp); :ref:`te_errno` :ref:`tapi_atm_aal5_add_csap_layer`(:ref:`asn_value`** csap_spec, const uint8_t* cpcs_uu, const uint8_t* cpi); :ref:`te_errno` :ref:`tapi_atm_add_pdu`(:ref:`asn_value`** tmpl_or_ptrn, bool is_pattern, const uint8_t* gfc, const uint16_t* vpi, const uint16_t* vci, const uint8_t* payload_type, bool* clp); :ref:`te_errno` :ref:`tapi_atm_add_payload`(:ref:`asn_value`* container, size_t pld_len, const uint8_t* pld); :ref:`te_errno` :ref:`tapi_atm_aal5_add_pdu`(:ref:`asn_value`** tmpl_or_ptrn, bool is_pattern, const uint8_t* cpcs_uu, const uint8_t* cpi); .. _details-group__tapi__tad__atm: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Declarations of API for TAPI ATM. Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved. Global Functions ---------------- .. index:: pair: function; tapi_atm_add_csap_layer .. _doxid-group__tapi__tad__atm_1ga97a47b8bf16e596fd2b9aa857d1f63ed: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_atm_add_csap_layer(:ref:`asn_value`** csap_spec, const char* device, :ref:`ndn_atm_type` type, const uint16_t* vpi, const uint16_t* vci, bool* congestion, bool* clp) Add ATM layer in CSAP specification. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - csap_spec - Location of CSAP specification pointer. * - device - Interface name on TA host or NULL (have to be not-NULL, if it is the bottom layer) * - type - ATM cell header format. * - vpi - Pointer to Virtual Path Identifier or NULL. If NULL, it have to be specified in traffic templates and match any, if it is not specified in traffic pattern. * - vci - Pointer to Virtual Channel Identifier or NULL. If NULL, it have to be specified in traffic templates and match any, if it is not specified in traffic pattern. * - congestion - Pointer to congestion bit value or NULL. If NULL, default value on transmit is 0 and match any on receive. * - clp - Pointer to Cell Loss Priority bit value or NULL. If NULL, default value on transmit is 0 and match any on receive. * - Status - code. .. index:: pair: function; tapi_atm_aal5_add_csap_layer .. _doxid-group__tapi__tad__atm_1ga24dab6105325441bc0079e8f46402be1: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_atm_aal5_add_csap_layer(:ref:`asn_value`** csap_spec, const uint8_t* cpcs_uu, const uint8_t* cpi) Add AAL5 layer in CSAP specification. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - csap_spec - Location of CSAP specification pointer. * - cpcs_uu - Pointer to CPCS User-to-User indication or NULL. If NULL, default value on transmit is 0 and match any on receive. * - cpi - Pointer to Common Part Indicator or NULL. If NULL, default value on transmit is 0 and match any on receive. * - Status - code. .. index:: pair: function; tapi_atm_add_pdu .. _doxid-group__tapi__tad__atm_1ga4d5ca790a74f5a1f80162eb4d515bc73: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_atm_add_pdu(:ref:`asn_value`** tmpl_or_ptrn, bool is_pattern, const uint8_t* gfc, const uint16_t* vpi, const uint16_t* vci, const uint8_t* payload_type, bool* clp) Add ATM 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 * - is_pattern - Is the first argument template or pattern * - gfc - Pointer to GFC field value or NULL, if unspecified (default value is 0) * - vpi - Pointer to VPI or NULL (default value have to be specified during CSAP creation) * - vci - Pointer to VCI or NULL (default value have to be specified during CSAP creation) * - payload_type - Pointer to payload type or NULL (default value is zero or'ed with congestion bit specified during CSAP creation) * - clp - Pointer to CLP or NULL (default value is specified during CSAP creation or 0) .. rubric:: Returns: Status code. .. index:: pair: function; tapi_atm_add_payload .. _doxid-group__tapi__tad__atm_1gadc24dc2e98818537c0c4eaa0aa95fba3: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_atm_add_payload(:ref:`asn_value`* container, size_t pld_len, const uint8_t* pld) Add ATM cell payload to traffic template or pattern unit. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - container - Container to add payload * - pld_len - Length of user payload (should be not greater than 48, if less, the rest is padded by zeros) * - pld - Payload .. rubric:: Returns: Status code. .. index:: pair: function; tapi_atm_aal5_add_pdu .. _doxid-group__tapi__tad__atm_1gae4fb962d138dfe06ffd83b2055e8f38b: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_atm_aal5_add_pdu(:ref:`asn_value`** tmpl_or_ptrn, bool is_pattern, const uint8_t* cpcs_uu, const uint8_t* cpi) Add AAL5 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 * - is_pattern - Is the first argument template or pattern * - cpcs_uu - Pointer to CPCS User-to-User indication or NULL. If NULL, default value is specified during CSAP creation or 0 on transmit/match any on receive. * - cpi - Pointer to Common Part Indicator or NULL. If NULL, default value is specified during CSAP creation or 0 on transmit/match any on receive. .. rubric:: Returns: Status code.