:orphan:

.. index:: pair: group; Timer
.. _doxid-group__te__tools__te__timer:

Timer
=====

.. toctree::
	:hidden:

	struct_te_timer_t.rst

Overview
~~~~~~~~

Functions to check if time expired



.. :ref:`More...<details-group__te__tools__te__timer>`


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

	
	// typedefs

	typedef struct :ref:`te_timer_t<doxid-structte__timer__t>` :ref:`te_timer_t<doxid-group__te__tools__te__timer_1gac0b1a74491b1cb6c13e2f6bb7564485f>`;

	// structs

	struct :ref:`te_timer_t<doxid-structte__timer__t>`;

	// global functions

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`te_timer_start<doxid-group__te__tools__te__timer_1ga11010f8eb6945fa12089998ccfdcba39>`(:ref:`te_timer_t<doxid-structte__timer__t>`* timer, unsigned int timeout_s);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`te_timer_restart<doxid-group__te__tools__te__timer_1ga1af397140eee92c9885a44ac86b315f3>`(:ref:`te_timer_t<doxid-structte__timer__t>`* timer, unsigned int timeout_s);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`te_timer_stop<doxid-group__te__tools__te__timer_1gaf43339ede0ca95bada4cc8d2d9753211>`(:ref:`te_timer_t<doxid-structte__timer__t>`* timer);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`te_timer_expired<doxid-group__te__tools__te__timer_1ga9574b418e00e17eff5c5cd830cf84ff2>`(:ref:`te_timer_t<doxid-structte__timer__t>`* timer);

	// macros

	#define :ref:`TE_TIMER_INIT<doxid-group__te__tools__te__timer_1ga57a6c1dd46021d609f66e97827ecbf6a>`

.. _details-group__te__tools__te__timer:

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

Functions to check if time expired



.. _doxid-group__te__tools__te__timer_1te_tools_te_timer_example:

Example of usage
~~~~~~~~~~~~~~~~

Let's assume we need to do some routine until certain time has expired

.. ref-code-block:: cpp

	#include "te_timer.h"
	
	:ref:`te_timer_t <doxid-structte__timer__t>` timer = :ref:`TE_TIMER_INIT <doxid-group__te__tools__te__timer_1ga57a6c1dd46021d609f66e97827ecbf6a>`;
	:ref:`te_errno <doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` rc;
	
	:ref:`CHECK_RC <doxid-group__te__ts__tapi__test__misc_1ga503a00c04b4caa0dbe1943277bc3946e>`(:ref:`te_timer_start <doxid-group__te__tools__te__timer_1ga11010f8eb6945fa12089998ccfdcba39>`(&timer, 3));
	do {
	    :ref:`VSLEEP <doxid-group__te__ts__tapi__test__misc_1ga2f5afc4eeea76ab6a9fcded22cab9936>`(1, "repeat some routine until the timer expires");
	} while ((rc = :ref:`te_timer_expired <doxid-group__te__tools__te__timer_1ga9574b418e00e17eff5c5cd830cf84ff2>`(&timer)) == 0);
	:ref:`CHECK_RC <doxid-group__te__ts__tapi__test__misc_1ga503a00c04b4caa0dbe1943277bc3946e>`(:ref:`te_timer_stop <doxid-group__te__tools__te__timer_1gaf43339ede0ca95bada4cc8d2d9753211>`(&timer));
	if (rc != :ref:`TE_ETIMEDOUT <doxid-te__errno_8h_1adeb27a52b59759a533c0d59ffb23052ead1e65a54da35a1ac032c8e1084fe7c2f>`)
	    :ref:`CHECK_RC <doxid-group__te__ts__tapi__test__misc_1ga503a00c04b4caa0dbe1943277bc3946e>`(rc);

Typedefs
--------

.. index:: pair: typedef; te_timer_t
.. _doxid-group__te__tools__te__timer_1gac0b1a74491b1cb6c13e2f6bb7564485f:

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

	typedef struct :ref:`te_timer_t<doxid-structte__timer__t>` te_timer_t

Timer context

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

.. index:: pair: function; te_timer_start
.. _doxid-group__te__tools__te__timer_1ga11010f8eb6945fa12089998ccfdcba39:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` te_timer_start(:ref:`te_timer_t<doxid-structte__timer__t>`* timer, unsigned int timeout_s)

Start timer



.. rubric:: Parameters:

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

	*
		- timer

		- Timer handle

	*
		- timeout_s

		- Timeout for triggering timer



.. rubric:: Returns:

Status code

.. index:: pair: function; te_timer_restart
.. _doxid-group__te__tools__te__timer_1ga1af397140eee92c9885a44ac86b315f3:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` te_timer_restart(:ref:`te_timer_t<doxid-structte__timer__t>`* timer, unsigned int timeout_s)

Restart already running or expired timer with a new timeout.



.. rubric:: Parameters:

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

	*
		- timer

		- Timer handle.

	*
		- timeout_s

		- Timeout for triggering timer.



.. rubric:: Returns:

Status code.

.. index:: pair: function; te_timer_stop
.. _doxid-group__te__tools__te__timer_1gaf43339ede0ca95bada4cc8d2d9753211:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` te_timer_stop(:ref:`te_timer_t<doxid-structte__timer__t>`* timer)

Stop the timer and free its resources.



.. rubric:: Parameters:

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

	*
		- timer

		- Timer handle.



.. rubric:: Returns:

Status code.

.. index:: pair: function; te_timer_expired
.. _doxid-group__te__tools__te__timer_1ga9574b418e00e17eff5c5cd830cf84ff2:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` te_timer_expired(:ref:`te_timer_t<doxid-structte__timer__t>`* timer)

Check whether timeout has expired or not.

It does not stop the timer if it expires, so :ref:`te_timer_stop() <doxid-group__te__tools__te__timer_1gaf43339ede0ca95bada4cc8d2d9753211>` should be called to free timer's resources.



.. rubric:: Parameters:

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

	*
		- timer

		- Timer handle

	*
		- 0

		- Time has not expired yet

	*
		- TE_ETIMEDOUT

		- Time has expired

	*
		- Others

		- Internal error, there is no way to use this timer any more



.. rubric:: Returns:

Status code

Macros
------

.. index:: pair: define; TE_TIMER_INIT
.. _doxid-group__te__tools__te__timer_1ga57a6c1dd46021d609f66e97827ecbf6a:

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

	#define TE_TIMER_INIT

On-stack timer context initializer