:orphan: .. index:: pair: group; Packet flow processing .. _doxid-group__tapi__tad__flow: Packet flow processing ====================== .. toctree:: :hidden: struct_tapi_flow_ep.rst struct_tapi_flow_s.rst struct_tapi_flow_traffic.rst Overview ~~~~~~~~ Packet flow processing API. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // typedefs typedef struct :ref:`tapi_flow_ep` :target:`tapi_flow_ep`; typedef struct :ref:`tapi_flow_traffic` :target:`tapi_flow_traffic`; typedef struct :ref:`tapi_flow_s` :ref:`tapi_flow_t`; // structs struct :ref:`tapi_flow_ep`; struct :ref:`tapi_flow_s`; struct :ref:`tapi_flow_traffic`; // global functions char* :ref:`tapi_flow_preprocess_links`(const char* param); char* :ref:`tapi_flow_preprocess_quotes`(const char* param); char** :ref:`tapi_flow_preprocess_args`(int argc, char** argv); :ref:`te_errno` :ref:`tapi_flow_conf_get`(int argc, char** argv, bool do_preprocess, :ref:`tapi_flow_t`* flow); :ref:`tapi_flow_ep`* :ref:`tapi_flow_find_ep`(:ref:`tapi_flow_t`* flow, const char* name); :ref:`tapi_flow_traffic`* :ref:`tapi_flow_find_traffic`(:ref:`tapi_flow_t`* flow, const char* name); :ref:`te_errno` :target:`tapi_flow_prepare_endpoints`(:ref:`tapi_flow_t`* flow); :ref:`te_errno` :target:`tapi_flow_prepare_traffic`(:ref:`tapi_flow_t`* flow); :ref:`te_errno` :target:`tapi_flow_csap_spec_to_stack`(:ref:`asn_value`* spec, char** stack); :ref:`te_errno` :target:`tapi_flow_gen_base_ptrn`(:ref:`asn_value`* rcv_ptrn, :ref:`asn_value`** base_ptrn_p); :ref:`te_errno` :target:`tapi_flow_setup_endpoints`(:ref:`tapi_flow_t`* flow); :ref:`te_errno` :target:`tapi_flow_prepare`(int argc, char** argv, bool do_preprocess, :ref:`tapi_flow_t`* flow); void :target:`tapi_flow_init`(:ref:`tapi_flow_t`* flow); void :target:`tapi_flow_fini`(:ref:`tapi_flow_t`* flow); :ref:`te_errno` :target:`tapi_flow_start`(:ref:`tapi_flow_t`* flow, char* name); :ref:`te_errno` :target:`tapi_flow_stop`(:ref:`tapi_flow_t`* flow, char* name, int* rcv_num_p, int* rcv_base_num_p); :ref:`te_errno` :target:`tapi_flow_check`(:ref:`tapi_flow_t`* flow, char* name, int* rcv_num_p, int* rcv_base_num_p); :ref:`te_errno` :target:`tapi_flow_check_sequence`(:ref:`tapi_flow_t`* flow, ...); :ref:`te_errno` :target:`tapi_flow_check_all`(:ref:`tapi_flow_t`* flow, const char* traffic_prefix); // macros #define :target:`TAPI_FLOW_RECV_COUNT_MAX` #define :target:`TAPI_FLOW_RECV_TIMEOUT` #define :ref:`TEST_GET_FLOW_CONFIG`(_flow, _do_preprocess) .. _details-group__tapi__tad__flow: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Packet flow processing API. Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved. Typedefs -------- .. index:: pair: typedef; tapi_flow_t .. _doxid-group__tapi__tad__flow_1ga5cd2c44fdf571768814210be593af69d: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_flow_s` tapi_flow_t General Flow structure List of endpoints and traffic entries Global Functions ---------------- .. index:: pair: function; tapi_flow_preprocess_links .. _doxid-group__tapi__tad__flow_1ga98240c0d3ca426fa03ce3278c513b730: .. ref-code-block:: cpp :class: doxyrest-title-code-block char* tapi_flow_preprocess_links(const char* param) Preprocess parameter value and resolve all configurator links within. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - param - Textual parameter value to preprocess .. rubric:: Returns: Preprocessed value on success or NULL on any error .. index:: pair: function; tapi_flow_preprocess_quotes .. _doxid-group__tapi__tad__flow_1ga1713f5703756ffc3470ee8436da5295c: .. ref-code-block:: cpp :class: doxyrest-title-code-block char* tapi_flow_preprocess_quotes(const char* param) Preprocess parameter value and substitute quoted values. Quoted notation is used to increase readability Also dereference configurator links if quotting means configurator link reduction. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - param - Textual parameter value to preprocess .. rubric:: Returns: Preprocessed value on success or NULL on any error .. index:: pair: function; tapi_flow_preprocess_args .. _doxid-group__tapi__tad__flow_1ga971c7b9e7616444e736a726831b4d828: .. ref-code-block:: cpp :class: doxyrest-title-code-block char** tapi_flow_preprocess_args(int argc, char** argv) Preprocess all test arguments .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - argc - Amount of arguments to preprocess * - argv - Array of test arguments .. rubric:: Returns: Array of preprocessed arguments on success or NULL on any error .. index:: pair: function; tapi_flow_conf_get .. _doxid-group__tapi__tad__flow_1ga8c526488d28704eaa8651358f52dc9ef: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_flow_conf_get(int argc, char** argv, bool do_preprocess, :ref:`tapi_flow_t`* flow) Get and process flow parametrisation from test arguments .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - argc - Amount of arguments to preprocess * - argv - Array of test arguments * - flow - Initialised flow structure (OUT) .. rubric:: Returns: 0, if success, or -1 otherwise .. index:: pair: function; tapi_flow_find_ep .. _doxid-group__tapi__tad__flow_1ga7e0b44693980122844e428ed074ca400: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`tapi_flow_ep`* tapi_flow_find_ep(:ref:`tapi_flow_t`* flow, const char* name) Find Endpoint by its name .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - flow - Flow structure to find endpoint in * - name - Name of endpoint to find .. rubric:: Returns: Endpoint structure, if success, or NULL otherwise .. index:: pair: function; tapi_flow_find_traffic .. _doxid-group__tapi__tad__flow_1ga51c8629fcb99591ffd75a25a21801a68: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`tapi_flow_traffic`* tapi_flow_find_traffic(:ref:`tapi_flow_t`* flow, const char* name) Find Traffic Entry by its name .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - flow - Flow structure to find traffic entry in * - name - Name of traffic entry to find .. rubric:: Returns: Endpoint structure, if success, or NULL otherwise Macros ------ .. index:: pair: define; TEST_GET_FLOW_CONFIG .. _doxid-group__tapi__tad__flow_1gab4919c3f36fd8e83316010742dacd57f: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TEST_GET_FLOW_CONFIG(_flow, _do_preprocess) Read configuration from test's parameters .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - platfrom_config - Pointer to platform_config_s structure to receive configuration (OUT)