:orphan:

.. index:: pair: group; tc qdisc TBF configuration
.. _doxid-group__tapi__conf__tbf:

tc qdisc TBF configuration
==========================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Copyright (C) 2020-2022 OKTET Labs Ltd. :ref:`More...<details-group__tapi__conf__tbf>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	
	// global functions

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_tbf_get_rate<doxid-group__tapi__conf__tbf_1gad36e4ad5b1fb64b9f194fdaf4a5e0702>`(const char* ta, const char* if_name, uint32_t* rate);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_tbf_set_rate<doxid-group__tapi__conf__tbf_1gafa79aa9f661921da6b34e9d0e432c68f>`(const char* ta, const char* if_name, uint32_t rate);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_tbf_get_bucket<doxid-group__tapi__conf__tbf_1ga2c569f3366dc69d58f30cb99128f4ae3>`(const char* ta, const char* if_name, uint32_t* bucket);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_tbf_set_bucket<doxid-group__tapi__conf__tbf_1ga1bc57a77b7622229c167d73d29dbc512>`(const char* ta, const char* if_name, uint32_t bucket);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_tbf_get_cell<doxid-group__tapi__conf__tbf_1ga3154e0d405716cb6867e0ff6dd6de700>`(const char* ta, const char* if_name, uint32_t* cell);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_tbf_set_cell<doxid-group__tapi__conf__tbf_1ga032b5cc09bea9e1dbe50075d16388ff8>`(const char* ta, const char* if_name, uint32_t cell);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_tbf_get_limit<doxid-group__tapi__conf__tbf_1ga2b0dbd939792a4c8e460d2f380152f8f>`(const char* ta, const char* if_name, uint32_t* limit);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_tbf_set_limit<doxid-group__tapi__conf__tbf_1ga31c2b327538ba1a4a80ce311b238050d>`(const char* ta, const char* if_name, uint32_t limit);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_tbf_get_latency<doxid-group__tapi__conf__tbf_1ga13fbe5eccc4212650f486937dbe9e876>`(const char* ta, const char* if_name, uint32_t* latency_us);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_tbf_set_latency<doxid-group__tapi__conf__tbf_1ga86e305fd0e5bf244d13241be522973ff>`(const char* ta, const char* if_name, uint32_t latency_us);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_tbf_get_peakrate<doxid-group__tapi__conf__tbf_1gae383b4d975acca2092d9f5ad068be0be>`(const char* ta, const char* if_name, uint32_t* peakrate);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_tbf_set_peakrate<doxid-group__tapi__conf__tbf_1ga7290aacbe2f385de33057bc17e04d71d>`(const char* ta, const char* if_name, uint32_t peakrate);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_tbf_get_mtu<doxid-group__tapi__conf__tbf_1gabee5a4fddaa222e226d81244a70a75dc>`(const char* ta, const char* if_name, uint32_t* mtu);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_tbf_set_mtu<doxid-group__tapi__conf__tbf_1gae20990e61f6a0276bff1ae62ed1f5cde>`(const char* ta, const char* if_name, uint32_t mtu);

.. _details-group__tapi__conf__tbf:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

Copyright (C) 2020-2022 OKTET Labs Ltd. All rights reserved.

Global Functions
----------------

.. index:: pair: function; tapi_cfg_tbf_get_rate
.. _doxid-group__tapi__conf__tbf_1gad36e4ad5b1fb64b9f194fdaf4a5e0702:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_tbf_get_rate(const char* ta, const char* if_name, uint32_t* rate)

Get rate of TBF qdisc on interface



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- ta

		- Test Agent

	*
		- if_name

		- Interface name

	*
		- rate

		- Rate value in bytes per second



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_tbf_set_rate
.. _doxid-group__tapi__conf__tbf_1gafa79aa9f661921da6b34e9d0e432c68f:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_tbf_set_rate(const char* ta, const char* if_name, uint32_t rate)

Set rate of TBF qdisc on interface



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- ta

		- Test Agent

	*
		- if_name

		- Interface name

	*
		- rate

		- Rate value in bytes per second



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_tbf_get_bucket
.. _doxid-group__tapi__conf__tbf_1ga2c569f3366dc69d58f30cb99128f4ae3:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_tbf_get_bucket(const char* ta, const char* if_name, uint32_t* bucket)

Get size of the TBF qdisc bucket on interface



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- ta

		- Test Agent

	*
		- if_name

		- Interface name

	*
		- bucket

		- Size of the bucket in bytes



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_tbf_set_bucket
.. _doxid-group__tapi__conf__tbf_1ga1bc57a77b7622229c167d73d29dbc512:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_tbf_set_bucket(const char* ta, const char* if_name, uint32_t bucket)

Set size of the TBF qdisc bucket on interface



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- ta

		- Test Agent

	*
		- if_name

		- Interface name

	*
		- bucket

		- Size of the bucket in bytes



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_tbf_get_cell
.. _doxid-group__tapi__conf__tbf_1ga3154e0d405716cb6867e0ff6dd6de700:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_tbf_get_cell(const char* ta, const char* if_name, uint32_t* cell)

Get size of a rate cell



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- ta

		- Test Agent

	*
		- if_name

		- Interface name

	*
		- cell

		- Size of a rate cell



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_tbf_set_cell
.. _doxid-group__tapi__conf__tbf_1ga032b5cc09bea9e1dbe50075d16388ff8:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_tbf_set_cell(const char* ta, const char* if_name, uint32_t cell)

Set size of a rate cell



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- ta

		- Test Agent

	*
		- if_name

		- Interface name

	*
		- cell

		- Size of a rate cell



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_tbf_get_limit
.. _doxid-group__tapi__conf__tbf_1ga2b0dbd939792a4c8e460d2f380152f8f:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_tbf_get_limit(const char* ta, const char* if_name, uint32_t* limit)

Get limit of TBF qdisc on interface



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- ta

		- Test Agent

	*
		- if_name

		- Interface name

	*
		- limit

		- Limit in bytes



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_tbf_set_limit
.. _doxid-group__tapi__conf__tbf_1ga31c2b327538ba1a4a80ce311b238050d:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_tbf_set_limit(const char* ta, const char* if_name, uint32_t limit)

Set limit of TBF qdisc on interface



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- ta

		- Test Agent

	*
		- if_name

		- Interface name

	*
		- limit

		- Limit in bytes



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_tbf_get_latency
.. _doxid-group__tapi__conf__tbf_1ga13fbe5eccc4212650f486937dbe9e876:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_tbf_get_latency(const char* ta, const char* if_name, uint32_t* latency_us)

Get limit of TBF qdisc by latency on interface



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- ta

		- Test Agent

	*
		- if_name

		- Interface name

	*
		- latency_us

		- Limit by latency in micro seconds



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_tbf_set_latency
.. _doxid-group__tapi__conf__tbf_1ga86e305fd0e5bf244d13241be522973ff:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_tbf_set_latency(const char* ta, const char* if_name, uint32_t latency_us)

Set limit of TBF qdisc by latency on interface



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- ta

		- Test Agent

	*
		- if_name

		- Interface name

	*
		- latency_us

		- Limit by latency in micro seconds



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_tbf_get_peakrate
.. _doxid-group__tapi__conf__tbf_1gae383b4d975acca2092d9f5ad068be0be:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_tbf_get_peakrate(const char* ta, const char* if_name, uint32_t* peakrate)

Get peakrate of TBF qdisc on interface



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- ta

		- Test Agent

	*
		- if_name

		- Interface name

	*
		- peakrate

		- Peakrate value in bytes per second



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_tbf_set_peakrate
.. _doxid-group__tapi__conf__tbf_1ga7290aacbe2f385de33057bc17e04d71d:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_tbf_set_peakrate(const char* ta, const char* if_name, uint32_t peakrate)

Set peakrate of TBF qdisc on interface



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- ta

		- Test Agent

	*
		- if_name

		- Interface name

	*
		- peakrate

		- Peakrate value in bytes per second



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_tbf_get_mtu
.. _doxid-group__tapi__conf__tbf_1gabee5a4fddaa222e226d81244a70a75dc:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_tbf_get_mtu(const char* ta, const char* if_name, uint32_t* mtu)

Get size of the TBF qdisc mtu on interface



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- ta

		- Test Agent

	*
		- if_name

		- Interface name

	*
		- mtu

		- Size of the mtu in bytes



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_tbf_set_mtu
.. _doxid-group__tapi__conf__tbf_1gae20990e61f6a0276bff1ae62ed1f5cde:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_tbf_set_mtu(const char* ta, const char* if_name, uint32_t mtu)

Set size of the TBF qdisc mtu on interface



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- ta

		- Test Agent

	*
		- if_name

		- Interface name

	*
		- mtu

		- Size of the mtu in bytes



.. rubric:: Returns:

Status code