:orphan: .. index:: pair: group; Generic TAD API .. _doxid-group__tapi__tad: Generic TAD API =============== .. toctree:: :hidden: struct_tapi_tad_trrecv_cb_data.rst Overview ~~~~~~~~ Definition of Test API for common Traffic Application Domain features. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // typedefs typedef void (*:ref:`tapi_tad_trrecv_cb`)( asn_value *packet, void *user_data ); typedef struct :ref:`tapi_tad_trrecv_cb_data` :ref:`tapi_tad_trrecv_cb_data`; // structs struct :ref:`tapi_tad_trrecv_cb_data`; // global functions int :ref:`tapi_csap_get_status`(const char* ta_name, int ta_sid, :ref:`csap_handle_t` csap_id, :ref:`tad_csap_status_t`* status); int :ref:`tapi_csap_get_total_bytes`(const char* ta_name, int ta_sid, :ref:`csap_handle_t` csap_id, unsigned long long int* p_bytes); int :ref:`tapi_csap_get_duration`(const char* ta_name, int ta_sid, :ref:`csap_handle_t` csap_id, struct timeval* p_dur); int :ref:`tapi_csap_param_get_llint`(const char* ta_name, int ta_sid, :ref:`csap_handle_t` csap_id, const char* param_name, int64_t* p_llint); int :ref:`tapi_csap_param_get_timestamp`(const char* ta_name, int ta_sid, :ref:`csap_handle_t` csap_id, const char* param_name, struct timeval* p_timestamp); int :ref:`tapi_tad_csap_create`(const char* ta_name, int session, const char* stack_id, const :ref:`asn_value`* csap_spec, :ref:`csap_handle_t`* handle); :ref:`te_errno` :ref:`tapi_tad_csap_destroy`(const char* ta_name, int session, :ref:`csap_handle_t` handle); int :ref:`tapi_tad_trsend_start`(const char* ta_name, int session, :ref:`csap_handle_t` csap, const :ref:`asn_value`* templ, :ref:`rcf_call_mode_t` blk_mode); :ref:`te_errno` :ref:`tapi_tad_trrecv_start`(const char* ta_name, int session, :ref:`csap_handle_t` handle, const :ref:`asn_value`* pattern, unsigned int timeout, unsigned int num, unsigned int mode); :ref:`tapi_tad_trrecv_cb_data`* :ref:`tapi_tad_trrecv_make_cb_data`(:ref:`tapi_tad_trrecv_cb` callback, void* user_data); :ref:`te_errno` :ref:`tapi_tad_trrecv_wait`(const char* ta_name, int session, :ref:`csap_handle_t` handle, :ref:`tapi_tad_trrecv_cb_data`* cb_data, unsigned int* num); :ref:`te_errno` :ref:`tapi_tad_trrecv_stop`(const char* ta_name, int session, :ref:`csap_handle_t` handle, :ref:`tapi_tad_trrecv_cb_data`* cb_data, unsigned int* num); :ref:`te_errno` :ref:`tapi_tad_trrecv_get`(const char* ta_name, int session, :ref:`csap_handle_t` handle, :ref:`tapi_tad_trrecv_cb_data`* cb_data, unsigned int* num); int :ref:`tapi_tad_add_iterator_for`(:ref:`asn_value`* templ, int begin, int end, int step); int :ref:`tapi_tad_add_iterator_ints`(:ref:`asn_value`* templ, int* array, size_t length); int :ref:`tapi_tad_forward_all`(const char* ta_name, int session, :ref:`csap_handle_t` csap_rcv, :ref:`csap_handle_t` csap_fwd, :ref:`asn_value`* pattern, unsigned int timeout, unsigned int* forwarded); :ref:`te_errno` :ref:`tapi_tad_socket_add_csap_layer`(:ref:`asn_value`** csap_spec, int fd); :ref:`te_errno` :ref:`tapi_tad_csap_get_no_match_pkts`(const char* ta_name, int session, :ref:`csap_handle_t` csap_id, unsigned int* val); :ref:`te_errno` :ref:`tapi_tad_csap_destroy_all`(int session); :ref:`te_errno` :ref:`tapi_tad_get_pkt_rx_ts`(:ref:`asn_value`* pkt, struct timeval* tv); .. _details-group__tapi__tad: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Definition of Test API for common Traffic Application Domain features. Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved. Typedefs -------- .. index:: pair: typedef; tapi_tad_trrecv_cb .. _doxid-group__tapi__tad_1ga72982fb5dbd458314d758c64e08521cf: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef void (*tapi_tad_trrecv_cb)( asn_value *packet, void *user_data ) Type for callback which will receive catched packets. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - packet - ASN value with received packet * - user_data - Pointer to opaque data, specified by user for his callback, .. rubric:: Returns: none .. index:: pair: typedef; tapi_tad_trrecv_cb_data .. _doxid-group__tapi__tad_1ga5cc2bbc1577ef0b2dbd98b43ff4a790b: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_tad_trrecv_cb_data` tapi_tad_trrecv_cb_data Structure for with parameters for receiving packets Global Functions ---------------- .. index:: pair: function; tapi_csap_get_status .. _doxid-group__tapi__tad_1gafb9174c88c2254f097c572a9b402d98e: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_csap_get_status(const char* ta_name, int ta_sid, :ref:`csap_handle_t` csap_id, :ref:`tad_csap_status_t`* status) Get status parameter of CSAP. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - - name of the Test Agent * - ta_sid - - session identifier to be used * - csap_id - - CSAP handle * - status - - location for status of csap (OUT) .. rubric:: Returns: Status code. .. index:: pair: function; tapi_csap_get_total_bytes .. _doxid-group__tapi__tad_1gad076999e621e6cffa78feb84371ca3d7: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_csap_get_total_bytes(const char* ta_name, int ta_sid, :ref:`csap_handle_t` csap_id, unsigned long long int* p_bytes) Get total number of bytes parameter of CSAP. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - - name of the Test Agent * - ta_sid - - session identifier to be used * - csap_id - - CSAP handle * - p_bytes - - location for total number of bytes (OUT) .. rubric:: Returns: Status code. .. index:: pair: function; tapi_csap_get_duration .. _doxid-group__tapi__tad_1gacfc62f1263f55fa1cde4a3d78bae33fb: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_csap_get_duration(const char* ta_name, int ta_sid, :ref:`csap_handle_t` csap_id, struct timeval* p_dur) Get duration of the last traffic receiving session on TA CSAP. Returned value is calculated as difference between timestamp of the last packet and timestamp of the first packet. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - - name of the Test Agent * - ta_sid - - session identifier to be used * - csap_id - - CSAP handle * - p_dur - - location for duration (OUT) .. rubric:: Returns: Status code. .. index:: pair: function; tapi_csap_param_get_llint .. _doxid-group__tapi__tad_1ga15013424af58061a90e28d76a8583ad1: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_csap_param_get_llint(const char* ta_name, int ta_sid, :ref:`csap_handle_t` csap_id, const char* param_name, int64_t* p_llint) Get 'long long int' CSAP parameter from TA. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - - name of the Test Agent * - ta_sid - - session identifier to be used * - csap_id - - CSAP handle * - param_name - - parameter name * - p_llint - - location for 'long long int' .. rubric:: Returns: Status code. .. index:: pair: function; tapi_csap_param_get_timestamp .. _doxid-group__tapi__tad_1gaead8a8c5b6570238ea404f83d76e119f: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_csap_param_get_timestamp(const char* ta_name, int ta_sid, :ref:`csap_handle_t` csap_id, const char* param_name, struct timeval* p_timestamp) Get timestamp CSAP parameter from TA in format ".". .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - - name of the Test Agent * - ta_sid - - session identifier to be used * - csap_id - - CSAP handle * - param_name - - parameter name * - p_timestamp - - location for timestamp .. rubric:: Returns: Status code. .. index:: pair: function; tapi_tad_csap_create .. _doxid-group__tapi__tad_1ga72802448118bc3ec04d5d77cc0556542: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_tad_csap_create(const char* ta_name, int session, const char* stack_id, const :ref:`asn_value`* csap_spec, :ref:`csap_handle_t`* handle) Creates CSAP (communication service access point) on the Test Agent. If ``stack_id`` is ``NULL``, then it will be determined by ``csap_spec`` .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name * - session - TA session or 0 * - stack_id - protocol stack identifier or ``NULL`` * - csap_spec - ASN value of type CSAP-spec * - handle - location for unique CSAP handle .. rubric:: Returns: zero on success or error code .. index:: pair: function; tapi_tad_csap_destroy .. _doxid-group__tapi__tad_1ga6540a89806d0460d06b778a5018d48c1: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_tad_csap_destroy(const char* ta_name, int session, :ref:`csap_handle_t` handle) Destroys CSAP (communication service access point) on the Test Agent. In comparison with :ref:`rcf_ta_csap_destroy() ` the function synchronizes /agent/csap subtree of the corresponding Test Agent. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name * - session - TA session or 0 * - handle - CSAP handle .. rubric:: Returns: Status code. .. index:: pair: function; tapi_tad_trsend_start .. _doxid-group__tapi__tad_1gac320e577a868bfb8bc3a2cfe3f1aca77: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_tad_trsend_start(const char* ta_name, int session, :ref:`csap_handle_t` csap, const :ref:`asn_value`* templ, :ref:`rcf_call_mode_t` blk_mode) This function is used to force sending of traffic via already created CSAP. Started sending process may be managed via standard function rcf_ta\_\*. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name * - session - TA session or 0 * - csap - CSAP handle * - templ - ASN value of type Traffic-Template * - blk_mode - mode of the operation: in blocking mode it suspends the caller until sending of all the traffic finishes .. rubric:: Returns: zero on success or error code .. index:: pair: function; tapi_tad_trrecv_start .. _doxid-group__tapi__tad_1gab222bbc26dac1ed366a9873608419ea7: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_tad_trrecv_start(const char* ta_name, int session, :ref:`csap_handle_t` handle, const :ref:`asn_value`* pattern, unsigned int timeout, unsigned int num, unsigned int mode) Start receiving of traffic via already created CSAP. Started receiving process may be managed via standard function rcf_ta\_\*. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name * - session - TA session or 0 * - handle - CSAP handle * - pattern - ASN value of type Traffic-Pattern * - timeout - Timeout for traffic receive operation. After this time interval CSAP stops capturing any traffic on the agent and will be waiting until :ref:`rcf_ta_trrecv_stop() ` or :ref:`rcf_ta_trrecv_wait() ` are called. * - num - Number of packets that needs to be captured; if it is zero, the number of received packets is not limited. * - mode - The flags allows to specify the receive mode. Count received packets only, store packets to get to the test side later or use pattern sequence matching. .. rubric:: Returns: Zero on success or error code .. index:: pair: function; tapi_tad_trrecv_make_cb_data .. _doxid-group__tapi__tad_1ga1e89780bd1dea4f4404d03c137a52518: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`tapi_tad_trrecv_cb_data`* tapi_tad_trrecv_make_cb_data(:ref:`tapi_tad_trrecv_cb` callback, void* user_data) Standard method to make struct with parameters for receiving packet. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - callback - User callback * - user_data - Pointer to user data for it .. rubric:: Returns: pointer to new instance of structure. .. index:: pair: function; tapi_tad_trrecv_wait .. _doxid-group__tapi__tad_1gad5c2122afaae9ae886d06266b2b4c269: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_tad_trrecv_wait(const char* ta_name, int session, :ref:`csap_handle_t` handle, :ref:`tapi_tad_trrecv_cb_data`* cb_data, unsigned int* num) Continue already started receiving process on CSAP. Blocks until reception is finished. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name * - session - TA session or 0 * - handle - CSAP handle * - cb_data - Struct with user-specified data for catching packets * - num - Location for number of received packets .. rubric:: Returns: status code .. index:: pair: function; tapi_tad_trrecv_stop .. _doxid-group__tapi__tad_1ga85799ed356025b67deb86bed410ceadc: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_tad_trrecv_stop(const char* ta_name, int session, :ref:`csap_handle_t` handle, :ref:`tapi_tad_trrecv_cb_data`* cb_data, unsigned int* num) Stops already started receiving process on CSAP. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name * - session - TA session or 0 * - handle - CSAP handle * - cb_data - Struct with user-specified data for catching packets * - num - Location for number of received packets .. rubric:: Returns: status code .. index:: pair: function; tapi_tad_trrecv_get .. _doxid-group__tapi__tad_1ga5a0556cc873b92a43ac50ff55da29b8d: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_tad_trrecv_get(const char* ta_name, int session, :ref:`csap_handle_t` handle, :ref:`tapi_tad_trrecv_cb_data`* cb_data, unsigned int* num) Get received packets from already started receiving process on CSAP. Don't block, don't stop receiving process. Received packets are removed from CSAP cache, and will not be returned again, on _wait, _stop or _get calls. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name * - session - TA session or 0 * - handle - CSAP handle * - cb_data - Struct with user-specified data for catching packets * - num - Location for number of received packets .. rubric:: Returns: status code .. index:: pair: function; tapi_tad_add_iterator_for .. _doxid-group__tapi__tad_1ga3ec752e24c1f184cab52b121f7b9ab5a: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_tad_add_iterator_for(:ref:`asn_value`* templ, int begin, int end, int step) Insert arithmetical progression iterator argument into Traffic-Template ASN value, at the end of iterator list. New iterator became most internal. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - templ - ASN value of Traffic-Template type * - begin - start of arithmetic progression * - end - end of arithmetic progression * - step - step of arithmetic progression .. rubric:: Returns: status code .. index:: pair: function; tapi_tad_add_iterator_ints .. _doxid-group__tapi__tad_1ga2d1ffd55f3fb2c611baff43278c37cf1: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_tad_add_iterator_ints(:ref:`asn_value`* templ, int* array, size_t length) Insert 'enumeration' iterator argument into Traffic-Template ASN value, at the end of iterator list. New iterator became most internal. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - templ - ASN value of Traffic-Template type * - array - pointer to array with enumerated values * - length - length of array .. rubric:: Returns: status code .. index:: pair: function; tapi_tad_forward_all .. _doxid-group__tapi__tad_1gafac580a340b09e07f96fa27449e43f36: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_tad_forward_all(const char* ta_name, int session, :ref:`csap_handle_t` csap_rcv, :ref:`csap_handle_t` csap_fwd, :ref:`asn_value`* pattern, unsigned int timeout, unsigned int* forwarded) Receive all data which currently are waiting for receive in specified CSAP and forward them into another CSAP, without passing via RCF to test. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - TA name * - session - RCF session id * - csap_rcv - identifier of receive CSAP * - csap_fwd - identifier of CSAP which should obtain data * - pattern - traffic Pattern to receive data * - timeout - timeout to wait data, in milliseconds * - forwarded - number of forwarded PDUs (OUT) .. rubric:: Returns: status code .. index:: pair: function; tapi_tad_socket_add_csap_layer .. _doxid-group__tapi__tad_1ga91d89bcf4491bc7836055ad21d4841e6: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_tad_socket_add_csap_layer(:ref:`asn_value`** csap_spec, int fd) Add socket layer over existing file descriptor in CSAP specification. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - csap_spec - Location of CSAP specification pointer. * - fd - File descriptor to read/write data * - Status - code. .. index:: pair: function; tapi_tad_csap_get_no_match_pkts .. _doxid-group__tapi__tad_1ga39f2b0c1d719f85a8a971ba1e75269bc: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_tad_csap_get_no_match_pkts(const char* ta_name, int session, :ref:`csap_handle_t` csap_id, unsigned int* val) Get number of unmatched packets using a parameter of CSAP. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - - name of the Test Agent * - session - - session identifier to be used * - csap_id - - CSAP handle * - val - - location for number of unmatched packets (OUT) .. rubric:: Returns: Status code. .. index:: pair: function; tapi_tad_csap_destroy_all .. _doxid-group__tapi__tad_1gad9bf07a3868a57b55d6945589aa83f8a: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_tad_csap_destroy_all(int session) Finalise all CSAP instances on all Test Agents using RCF. The function will synchronise ``/agent/csap`` subtrees for all the agents. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - session - RCF session ID .. rubric:: Returns: Status code. .. index:: pair: function; tapi_tad_get_pkt_rx_ts .. _doxid-group__tapi__tad_1ga546754e80fb0b2a4217bbc89099ba370: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_tad_get_pkt_rx_ts(:ref:`asn_value`* pkt, struct timeval* tv) Get timestamp from a packet captured by CSAP. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - pkt - Packet captured by CSAP (described in ASN). * - tv - Where to save obtained timestamp. .. rubric:: Returns: Status code.