:orphan: .. index:: pair: group; Network Emulator configuration .. _doxid-group__tapi__conf__netem: Network Emulator configuration ============================== .. toctree:: :hidden: Overview ~~~~~~~~ Copyright (C) 2004-2022 OKTET Labs Ltd. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // global functions :ref:`te_errno` :ref:`tapi_cfg_netem_get_param`(const char* ta, const char* if_name, const char* param, char** value); :ref:`te_errno` :ref:`tapi_cfg_netem_set_param`(const char* ta, const char* if_name, const char* param, const char* value); :ref:`te_errno` :ref:`tapi_cfg_netem_set_delay`(const char* ta, const char* if_name, uint32_t delay_us); :ref:`te_errno` :ref:`tapi_cfg_netem_get_delay`(const char* ta, const char* if_name, uint32_t* delay_us); :ref:`te_errno` :ref:`tapi_cfg_netem_set_jitter`(const char* ta, const char* if_name, uint32_t jitter_us); :ref:`te_errno` :ref:`tapi_cfg_netem_get_jitter`(const char* ta, const char* if_name, uint32_t* jitter_us); :ref:`te_errno` :ref:`tapi_cfg_netem_set_delay_correlation`(const char* ta, const char* if_name, double delay_correlation); :ref:`te_errno` :ref:`tapi_cfg_netem_get_delay_correlation`(const char* ta, const char* if_name, double* delay_correlation); :ref:`te_errno` :ref:`tapi_cfg_netem_set_loss`(const char* ta, const char* if_name, double loss); :ref:`te_errno` :ref:`tapi_cfg_netem_get_loss`(const char* ta, const char* if_name, double* loss); :ref:`te_errno` :ref:`tapi_cfg_netem_set_loss_correlation`(const char* ta, const char* if_name, double loss_correlation); :ref:`te_errno` :ref:`tapi_cfg_netem_get_loss_correlation`(const char* ta, const char* if_name, double* loss_correlation); :ref:`te_errno` :ref:`tapi_cfg_netem_set_duplicate`(const char* ta, const char* if_name, double duplicate); :ref:`te_errno` :ref:`tapi_cfg_netem_get_duplicate`(const char* ta, const char* if_name, double* duplicate); :ref:`te_errno` :ref:`tapi_cfg_netem_set_duplicate_correlation`(const char* ta, const char* if_name, double duplicate_correlation); :ref:`te_errno` :ref:`tapi_cfg_netem_get_duplicate_correclation`(const char* ta, const char* if_name, double* duplicate_correlation); :ref:`te_errno` :ref:`tapi_cfg_netem_set_limit`(const char* ta, const char* if_name, uint32_t limit); :ref:`te_errno` :ref:`tapi_cfg_netem_get_limit`(const char* ta, const char* if_name, uint32_t* limit); :ref:`te_errno` :ref:`tapi_cfg_netem_set_gap`(const char* ta, const char* if_name, uint32_t gap); :ref:`te_errno` :ref:`tapi_cfg_netem_get_gap`(const char* ta, const char* if_name, uint32_t* gap); :ref:`te_errno` :ref:`tapi_cfg_netem_set_reorder_probability`(const char* ta, const char* if_name, double reorder_probability); :ref:`te_errno` :ref:`tapi_cfg_netem_get_reorder_probability`(const char* ta, const char* if_name, double* reorder_probability); :ref:`te_errno` :ref:`tapi_cfg_netem_set_reorder_correlation`(const char* ta, const char* if_name, double reorder_correlation); :ref:`te_errno` :ref:`tapi_cfg_netem_get_reorder_correlation`(const char* ta, const char* if_name, double* reorder_correlation); :ref:`te_errno` :ref:`tapi_cfg_netem_set_corruption_probability`(const char* ta, const char* if_name, double corruption_probability); :ref:`te_errno` :ref:`tapi_cfg_netem_get_corruption_probability`(const char* ta, const char* if_name, double* corruption_probability); :ref:`te_errno` :ref:`tapi_cfg_netem_set_corruption_correlation`(const char* ta, const char* if_name, double corruption_correlation); :ref:`te_errno` :ref:`tapi_cfg_netem_get_corruption_correlation`(const char* ta, const char* if_name, double* corruption_correlation); // macros #define :target:`TAPI_CFG_NETEM_MAX_PARAM_LEN` .. _details-group__tapi__conf__netem: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved. Global Functions ---------------- .. index:: pair: function; tapi_cfg_netem_get_param .. _doxid-group__tapi__conf__netem_1gac9fc389a158c59ca68867d6351e079fc: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_netem_get_param(const char* ta, const char* if_name, const char* param, char** value) Get value of NetEm parameter as string value should be free() after use .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent * - if_name - Interface name * - param - NetEm parameter name * - value - Parameter value .. rubric:: Returns: Status code .. index:: pair: function; tapi_cfg_netem_set_param .. _doxid-group__tapi__conf__netem_1gaff5875f92a81d320f7c0a15b5f0779dd: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_netem_set_param(const char* ta, const char* if_name, const char* param, const char* value) Set value of NetEm parameter as string .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent * - if_name - Interface name * - param - NetEm parameter name * - value - Parameter value .. rubric:: Returns: Status code .. index:: pair: function; tapi_cfg_netem_set_delay .. _doxid-group__tapi__conf__netem_1gaeffd77e5d59247e499bd2348d00ae590: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_netem_set_delay(const char* ta, const char* if_name, uint32_t delay_us) Set packet delay on interface .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent * - if_name - Interface name * - delay_us - Delay value in usec .. rubric:: Returns: Status code .. index:: pair: function; tapi_cfg_netem_get_delay .. _doxid-group__tapi__conf__netem_1gacfab78c832d0734c8f5758156eec1a1f: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_netem_get_delay(const char* ta, const char* if_name, uint32_t* delay_us) Get packet delay on interface .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent * - if_name - Interface name * - delay_us - Delay value in usec .. rubric:: Returns: Status code .. index:: pair: function; tapi_cfg_netem_set_jitter .. _doxid-group__tapi__conf__netem_1gaf2a3caeabcc8256ce1977574665ebc30: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_netem_set_jitter(const char* ta, const char* if_name, uint32_t jitter_us) Set packet jitter on interface .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent * - if_name - Interface name * - jitter_us - Jitter value in usec .. rubric:: Returns: Status code .. index:: pair: function; tapi_cfg_netem_get_jitter .. _doxid-group__tapi__conf__netem_1gadf6c4828bbef004c58ba36c03290d9a9: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_netem_get_jitter(const char* ta, const char* if_name, uint32_t* jitter_us) Get packet jitter on interface .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent * - if_name - Interface name * - jitter_us - Jitter value in usec .. rubric:: Returns: Status code .. index:: pair: function; tapi_cfg_netem_set_delay_correlation .. _doxid-group__tapi__conf__netem_1gab1bbc6443ceef82fbc3a04043898417f: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_netem_set_delay_correlation(const char* ta, const char* if_name, double delay_correlation) Set packet delay correlation on interface .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent * - if_name - Interface name * - delay_correlation - Delay correlation value [0-100]% .. rubric:: Returns: Status code .. index:: pair: function; tapi_cfg_netem_get_delay_correlation .. _doxid-group__tapi__conf__netem_1ga2cfde0b50e10bc3f7b86839f36644dc4: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_netem_get_delay_correlation(const char* ta, const char* if_name, double* delay_correlation) Get packet delay correlation on interface .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent * - if_name - Interface name * - delay_correlation - Delay correlation value [0-100]% .. rubric:: Returns: Status code .. index:: pair: function; tapi_cfg_netem_set_loss .. _doxid-group__tapi__conf__netem_1ga192a8664ce503e55a236260747c21d23: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_netem_set_loss(const char* ta, const char* if_name, double loss) Set packet loss on interface .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent * - if_name - Interface name * - loss - Loss probability [0-100]% .. rubric:: Returns: Status code .. index:: pair: function; tapi_cfg_netem_get_loss .. _doxid-group__tapi__conf__netem_1gaa0d4589df8e38750e62a4d41012e2f9e: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_netem_get_loss(const char* ta, const char* if_name, double* loss) Get packet loss on interface .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent * - if_name - Interface name * - loss - Loss probability [0-100]% .. rubric:: Returns: Status code .. index:: pair: function; tapi_cfg_netem_set_loss_correlation .. _doxid-group__tapi__conf__netem_1ga73d30764ebdb3602451f4df873b17a9c: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_netem_set_loss_correlation(const char* ta, const char* if_name, double loss_correlation) Set packet loss correlation on interface .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent * - if_name - Interface name * - loss_correlation - Loss correlation [0-100]% .. rubric:: Returns: Status code .. index:: pair: function; tapi_cfg_netem_get_loss_correlation .. _doxid-group__tapi__conf__netem_1ga87e1adf018138031ef236de656f3657c: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_netem_get_loss_correlation(const char* ta, const char* if_name, double* loss_correlation) Get packet loss correlation on interface .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent * - if_name - Interface name * - loss_correlation - Loss correlation [0-100]% .. rubric:: Returns: Status code .. index:: pair: function; tapi_cfg_netem_set_duplicate .. _doxid-group__tapi__conf__netem_1ga9a6e04bdc7800f453a09450a59584c1f: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_netem_set_duplicate(const char* ta, const char* if_name, double duplicate) Set packet duplicate on interface .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent * - if_name - Interface name * - duplicate - Duplicate probability [0-100]% .. rubric:: Returns: Status code .. index:: pair: function; tapi_cfg_netem_get_duplicate .. _doxid-group__tapi__conf__netem_1gab47113ba2e4a87c5fcd1659705db60e0: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_netem_get_duplicate(const char* ta, const char* if_name, double* duplicate) Get packet duplicate on interface .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent * - if_name - Interface name * - duplicate - Duplicate probability [0-100]% .. rubric:: Returns: Status code .. index:: pair: function; tapi_cfg_netem_set_duplicate_correlation .. _doxid-group__tapi__conf__netem_1gae9845ea3f6018e6aad5525e632231ce0: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_netem_set_duplicate_correlation(const char* ta, const char* if_name, double duplicate_correlation) Set packet duplicate correlation on interface .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent * - if_name - Interface name * - duplicate_correlation - Duplicate correlation [0-100]% .. rubric:: Returns: Status code .. index:: pair: function; tapi_cfg_netem_get_duplicate_correclation .. _doxid-group__tapi__conf__netem_1gaab43250ba95718c42f10540506433b9a: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_netem_get_duplicate_correclation(const char* ta, const char* if_name, double* duplicate_correlation) Get packet duplicate correlation on interface .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent * - if_name - Interface name * - duplicate_correlation - Duplicate correlation [0-100]% .. rubric:: Returns: Status code .. index:: pair: function; tapi_cfg_netem_set_limit .. _doxid-group__tapi__conf__netem_1ga5c7f1d998017b26061f3819c7715e3fe: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_netem_set_limit(const char* ta, const char* if_name, uint32_t limit) Set packet limit on interface .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent * - if_name - Interface name * - limit - Limit value .. rubric:: Returns: Status code .. index:: pair: function; tapi_cfg_netem_get_limit .. _doxid-group__tapi__conf__netem_1ga008b1de9806588c06341847e5a11f228: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_netem_get_limit(const char* ta, const char* if_name, uint32_t* limit) Get packet limit on interface .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent * - if_name - Interface name * - limit - Limit value .. rubric:: Returns: Status code .. index:: pair: function; tapi_cfg_netem_set_gap .. _doxid-group__tapi__conf__netem_1ga94cbf638e0bb0e98bdc4d5d30ebc227a: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_netem_set_gap(const char* ta, const char* if_name, uint32_t gap) Set packet gap on interface .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent * - if_name - Interface name * - gap - Gap value .. rubric:: Returns: Status code .. index:: pair: function; tapi_cfg_netem_get_gap .. _doxid-group__tapi__conf__netem_1ga5e059017df39b55e013520ab728bb492: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_netem_get_gap(const char* ta, const char* if_name, uint32_t* gap) Get packet gap on interface .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent * - if_name - Interface name * - gap - Gap value .. rubric:: Returns: Status code .. index:: pair: function; tapi_cfg_netem_set_reorder_probability .. _doxid-group__tapi__conf__netem_1ga23776e131aca799eae6ebc9afa7c3513: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_netem_set_reorder_probability(const char* ta, const char* if_name, double reorder_probability) Set packet reorder on interface .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent * - if_name - Interface name * - reorder_probability - Reorder probability value [0-100]% .. rubric:: Returns: Status code .. index:: pair: function; tapi_cfg_netem_get_reorder_probability .. _doxid-group__tapi__conf__netem_1ga2120ef44cf81558ffecd836aa9469276: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_netem_get_reorder_probability(const char* ta, const char* if_name, double* reorder_probability) Get packet reorder on interface .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent * - if_name - Interface name * - reorder_probability - Reorder probability value [0-100]% .. rubric:: Returns: Status code .. index:: pair: function; tapi_cfg_netem_set_reorder_correlation .. _doxid-group__tapi__conf__netem_1gaa77b6f62a798a09a7d25959476bf90bf: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_netem_set_reorder_correlation(const char* ta, const char* if_name, double reorder_correlation) Set packet reorder correlation on interface .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent * - if_name - Interface name * - reorder_correlation - Reorder correlation value [0-100]% .. rubric:: Returns: Status code .. index:: pair: function; tapi_cfg_netem_get_reorder_correlation .. _doxid-group__tapi__conf__netem_1ga1c423ead557912df60aeef14c8e128a0: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_netem_get_reorder_correlation(const char* ta, const char* if_name, double* reorder_correlation) Get packet reorder correlation on interface .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent * - if_name - Interface name * - reorder_correlation - Reorder probability value [0-100]% .. rubric:: Returns: Status code .. index:: pair: function; tapi_cfg_netem_set_corruption_probability .. _doxid-group__tapi__conf__netem_1gab7c9fb01de9fda640952bb62cdf386ec: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_netem_set_corruption_probability(const char* ta, const char* if_name, double corruption_probability) Set packet corruption probability on interface .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent * - if_name - Interface name * - corruption_probability - Corruption probability value [0-100]% .. rubric:: Returns: Status code .. index:: pair: function; tapi_cfg_netem_get_corruption_probability .. _doxid-group__tapi__conf__netem_1gaa4d432c56ac122066d7d2f1309039d1f: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_netem_get_corruption_probability(const char* ta, const char* if_name, double* corruption_probability) Get packet corruption probability on interface .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent * - if_name - Interface name * - corruption_probability - Corruption probability value [0-100]% .. rubric:: Returns: Status code .. index:: pair: function; tapi_cfg_netem_set_corruption_correlation .. _doxid-group__tapi__conf__netem_1gaa0bd88886e84a4cc9225b2c5126d6bbd: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_netem_set_corruption_correlation(const char* ta, const char* if_name, double corruption_correlation) Set packet corruption correlation on interface .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent * - if_name - Interface name * - corruption_correlation - Corruption correlation value [0-100]% .. rubric:: Returns: Status code .. index:: pair: function; tapi_cfg_netem_get_corruption_correlation .. _doxid-group__tapi__conf__netem_1gaaaf5bcf1669262322b527716ba08cb27: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_netem_get_corruption_correlation(const char* ta, const char* if_name, double* corruption_correlation) Get packet corruption correlation on interface .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent * - if_name - Interface name * - corruption_correlation - Corruption correlation value [0-100]% .. rubric:: Returns: Status code