:orphan:

.. index:: pair: group; Stopwatch
.. _doxid-group__te__tools__te__stopwatch:

Stopwatch
=========

.. toctree::
	:hidden:

	struct_te_stopwatch_t.rst

Overview
~~~~~~~~

Functions for time measurement

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


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

	
	// typedefs

	typedef struct :ref:`te_stopwatch_t<doxid-structte__stopwatch__t>` :ref:`te_stopwatch_t<doxid-group__te__tools__te__stopwatch_1gaa01a0099e8ff941f8a51a7c5fd9d3a32>`;

	// structs

	struct :ref:`te_stopwatch_t<doxid-structte__stopwatch__t>`;

	// global functions

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`te_stopwatch_start<doxid-group__te__tools__te__stopwatch_1gabf198ae5214277bf8380fde5380a6fef>`(:ref:`te_stopwatch_t<doxid-structte__stopwatch__t>`* stopwatch);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`te_stopwatch_stop<doxid-group__te__tools__te__stopwatch_1gaf8c8660b67aededc291bd316ae9777da>`(:ref:`te_stopwatch_t<doxid-structte__stopwatch__t>`* stopwatch, struct timeval* lap);

	// macros

	#define :ref:`TE_STOPWATCH_INIT<doxid-group__te__tools__te__stopwatch_1gaea8fc7f89e66bea5ebf91bc2f2d214a0>`

.. _details-group__te__tools__te__stopwatch:

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

Functions for time measurement

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



.. _doxid-group__te__tools__te__stopwatch_1te_tools_te_stopwatch_example:

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

Let's assume we need to measure some routine duration

.. ref-code-block:: cpp

	#include "te_stopwatch.h"
	
	:ref:`te_stopwatch_t <doxid-structte__stopwatch__t>` stopwatch = :ref:`TE_STOPWATCH_INIT <doxid-group__te__tools__te__stopwatch_1gaea8fc7f89e66bea5ebf91bc2f2d214a0>`;
	struct timeval duration;
	
	:ref:`CHECK_RC <doxid-group__te__ts__tapi__test__misc_1ga503a00c04b4caa0dbe1943277bc3946e>`(:ref:`te_stopwatch_start <doxid-group__te__tools__te__stopwatch_1gabf198ae5214277bf8380fde5380a6fef>`(&stopwatch));
	:ref:`RING <doxid-group__logger__api_1ga7b815b8f872c9036bba29ddfecd07368>`("Some routine");
	:ref:`CHECK_RC <doxid-group__te__ts__tapi__test__misc_1ga503a00c04b4caa0dbe1943277bc3946e>`(:ref:`te_stopwatch_stop <doxid-group__te__tools__te__stopwatch_1gaf8c8660b67aededc291bd316ae9777da>`(&stopwatch, &duration));

Typedefs
--------

.. index:: pair: typedef; te_stopwatch_t
.. _doxid-group__te__tools__te__stopwatch_1gaa01a0099e8ff941f8a51a7c5fd9d3a32:

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

	typedef struct :ref:`te_stopwatch_t<doxid-structte__stopwatch__t>` te_stopwatch_t

Stopwatch context

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

.. index:: pair: function; te_stopwatch_start
.. _doxid-group__te__tools__te__stopwatch_1gabf198ae5214277bf8380fde5380a6fef:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` te_stopwatch_start(:ref:`te_stopwatch_t<doxid-structte__stopwatch__t>`* stopwatch)

Start stopwatch. It does not care if the stopwatch is already started, it will restart it.



.. rubric:: Parameters:

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

	*
		- stopwatch

		- Stopwatch handle



.. rubric:: Returns:

Status code

.. index:: pair: function; te_stopwatch_stop
.. _doxid-group__te__tools__te__stopwatch_1gaf8c8660b67aededc291bd316ae9777da:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` te_stopwatch_stop(:ref:`te_stopwatch_t<doxid-structte__stopwatch__t>`* stopwatch, struct timeval* lap)

Stop stopwatch and calculate its duration



.. rubric:: Parameters:

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

	*
		- stopwatch

		- Stopwatch handle

	*
		- lap

		- Overall time of stopwatch job



.. rubric:: Returns:

Status code

Macros
------

.. index:: pair: define; TE_STOPWATCH_INIT
.. _doxid-group__te__tools__te__stopwatch_1gaea8fc7f89e66bea5ebf91bc2f2d214a0:

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

	#define TE_STOPWATCH_INIT

On-stack stopwatch context initializer