:orphan:

.. index:: pair: group; Sleep
.. _doxid-group__te__tools__te__sleep:

Sleep
=====

.. toctree::
	:hidden:

Overview
~~~~~~~~

Functions for different delays. :ref:`More...<details-group__te__tools__te__sleep>`


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

	
	// global functions

	static void :ref:`te_sleep<doxid-group__te__tools__te__sleep_1ga79c6526b0683a5192bce8eda2b977331>`(unsigned int to_sleep);
	static void :ref:`te_motivated_usleep<doxid-group__te__tools__te__sleep_1gae8b5a59a86260215b2307878b90b5ded>`(unsigned int to_sleep, const char* why);
	static void :ref:`te_motivated_msleep<doxid-group__te__tools__te__sleep_1gad378ccfe4590c24f324922a82d5058b1>`(unsigned int to_sleep, const char* why);
	static void :ref:`te_motivated_sleep<doxid-group__te__tools__te__sleep_1gabcf9dd4f982ab3a82d93daedc3eb917b>`(unsigned int to_sleep, const char* why);
	static void :ref:`te_msleep<doxid-group__te__tools__te__sleep_1gad552fd553277891682f33f1cdeb977f4>`(unsigned int to_sleep);
	static void :ref:`te_usleep<doxid-group__te__tools__te__sleep_1ga287827f4faaeadf10021a91e28a77e5e>`(unsigned int to_sleep);

	// macros

	#define :ref:`TIMEVAL_SUB<doxid-group__te__tools__te__sleep_1gabfdff068424c554a37452c42814e0f39>`(_tv1, _tv2)

.. _details-group__te__tools__te__sleep:

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

Functions for different delays.

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

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

.. index:: pair: function; te_sleep
.. _doxid-group__te__tools__te__sleep_1ga79c6526b0683a5192bce8eda2b977331:

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

	static void te_sleep(unsigned int to_sleep)

Sleep specified number of seconds.



.. rubric:: Parameters:

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

	*
		- to_sleep

		- number of seconds to sleep

.. index:: pair: function; te_motivated_usleep
.. _doxid-group__te__tools__te__sleep_1gae8b5a59a86260215b2307878b90b5ded:

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

	static void te_motivated_usleep(unsigned int to_sleep, const char* why)

Sleep specified number of microseconds.



.. rubric:: Parameters:

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

	*
		- to_sleep

		- Number of microseconds to sleep

	*
		- why

		- String that describes reason to sleep here.

.. index:: pair: function; te_motivated_msleep
.. _doxid-group__te__tools__te__sleep_1gad378ccfe4590c24f324922a82d5058b1:

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

	static void te_motivated_msleep(unsigned int to_sleep, const char* why)

Sleep specified number of milliseconds.



.. rubric:: Parameters:

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

	*
		- to_sleep

		- Number of milliseconds to sleep

	*
		- why

		- String that describes reason to sleep here.

.. index:: pair: function; te_motivated_sleep
.. _doxid-group__te__tools__te__sleep_1gabcf9dd4f982ab3a82d93daedc3eb917b:

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

	static void te_motivated_sleep(unsigned int to_sleep, const char* why)

Sleep specified number of seconds.



.. rubric:: Parameters:

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

	*
		- to_sleep

		- Number of seconds to sleep

	*
		- why

		- String that describes reason to sleep here.

.. index:: pair: function; te_msleep
.. _doxid-group__te__tools__te__sleep_1gad552fd553277891682f33f1cdeb977f4:

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

	static void te_msleep(unsigned int to_sleep)

Sleep specified number of milliseconds.



.. rubric:: Parameters:

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

	*
		- to_sleep

		- number of milliseconds to sleep

.. index:: pair: function; te_usleep
.. _doxid-group__te__tools__te__sleep_1ga287827f4faaeadf10021a91e28a77e5e:

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

	static void te_usleep(unsigned int to_sleep)

Sleep specified number of microseconds.



.. rubric:: Parameters:

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

	*
		- to_sleep

		- number of milliseconds to sleep

Macros
------

.. index:: pair: define; TIMEVAL_SUB
.. _doxid-group__te__tools__te__sleep_1gabfdff068424c554a37452c42814e0f39:

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

	#define TIMEVAL_SUB(_tv1, _tv2)

Substract tv1 to tv2 of type struct timeval.



.. rubric:: Parameters:

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

	*
		- _tv1

		- 

	*
		- _tv2

		- 



.. rubric:: Returns:

Diff in microseconds