:orphan:

.. index:: pair: group; Date, time
.. _doxid-group__te__tools__te__time:

Date, time
==========

.. toctree::
	:hidden:

Overview
~~~~~~~~

Functions to operate the date and time. :ref:`More...<details-group__te__tools__te__time>`


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

	
	// global functions

	char* :ref:`te_time_current_date2str<doxid-group__te__tools__te__time_1ga8aebf1fd1a2794795e562ba386b42fe8>`(void);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`te_gettimeofday<doxid-group__te__tools__te__time_1ga43cc90f07f70e630d287ef87a9a06246>`(struct timeval* tv, struct timezone* tz);
	void :ref:`te_timersub<doxid-group__te__tools__te__time_1gabe463b991f33fda0d911700c5c68f84b>`(const struct timeval* a, const struct timeval* b, struct timeval* res);

.. _details-group__te__tools__te__time:

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

Functions to operate the date and time.

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

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

.. index:: pair: function; te_time_current_date2str
.. _doxid-group__te__tools__te__time_1ga8aebf1fd1a2794795e562ba386b42fe8:

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

	char* te_time_current_date2str(void)

Get string representation of the current date.

Return value should be freed with free(3) when it is no longer needed.



.. rubric:: Returns:

Current date, or ``NULL`` in case of failure.

.. index:: pair: function; te_gettimeofday
.. _doxid-group__te__tools__te__time_1ga43cc90f07f70e630d287ef87a9a06246:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` te_gettimeofday(struct timeval* tv, struct timezone* tz)

Wrapper over gettimeofday() reporting error in TE format.



.. rubric:: Parameters:

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

	*
		- tv

		- Pointer to timeval structure.

	*
		- tz

		- Pointer to timezone structure (may be ``NULL``).



.. rubric:: Returns:

Status code.

.. index:: pair: function; te_timersub
.. _doxid-group__te__tools__te__time_1gabe463b991f33fda0d911700c5c68f84b:

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

	void te_timersub(const struct timeval* a, const struct timeval* b, struct timeval* res)

Subtract the time value in ``b`` from the time value in ``a``, and place the result in the timeval pointed to by ``res``

It is an alternative to BSD timersub()



.. rubric:: Parameters:

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

	*
		- a

		- Minuend

	*
		- b

		- Subtrahend

	*
		- res

		- Difference