#include "xroad_common_types.h"
#include "xroad_string.h"
#include "xroad_tzone.h"
#include <stdint.h>
#include <time.h>
#include <sys/time.h>

Include dependency graph for xroad_time.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	xroad_time_t

Macros
#define	xroad_time_null (xroad_time_t){0}

#define	xroad_time_to_str(tm)

#define	xroad_time_to_sql(v)

Functions
xroad_time_t	xroad_time_create (uint8_t hour, uint8_t min, uint8_t sec, uint32_t usec, xroad_tzone_t tz)

bool	xroad_time_is_null (xroad_time_t time)

xroad_time_t	xroad_time_from_str (xroad_str_t time)

int64_t	xroad_time_cmp (xroad_time_t lhs, xroad_time_t rhs)

xroad_time_t	xroad_time_min (xroad_time_t a, xroad_time_t b)

xroad_time_t	xroad_time_max (xroad_time_t a, xroad_time_t b)

int64_t	xroad_time_to_usec (xroad_time_t time)

xroad_time_t	xroad_time_from_ts (xroad_timestamp_t ts, xroad_tzone_t tz)

xroad_timestamp_t	xroad_time_to_ts (xroad_time_t time)

xroad_time_t	xroad_time_now (xroad_tzone_t tz)

xroad_time_t	xroad_time_change_tz (xroad_time_t tm, xroad_tzone_t new_tz)

int64_t	xroad_time_distance (xroad_time_t a, xroad_time_t b)

xroad_time_t	xroad_time_adjust (xroad_time_t time, int64_t usec)

xroad_timestamp_t	xroad_now ()

xroad_timestamp_t	xroad_now_nano ()

xroad_timestamp_t	xroad_now_sec ()

xroad_timestamp_t	xroad_now_monotonic (void)

int64_t	xroad_time_start_of_day (time_t now)

Detailed Description

Author: Danil Krivopustov

Macro Definition Documentation

◆ xroad_time_to_sql

#define xroad_time_to_sql ( v )

Value:

({                                           \
   char* buf = "NULL";                       \
   uint32_t len = 4;                         \
   xroad_time_t dt = (v);                    \
   if (!xroad_time_is_null(dt))              \
   {                                         \
      xroad_str_t s = xroad_time_to_str(dt); \
      buf = alloca(s.len + 2);               \
      buf[0] = '\'';                         \
      memcpy(buf + 1, s.data, s.len);        \
      buf[s.len + 1] = '\'';                 \
      len = s.len + 2;                       \
   }                                         \
   xroad_str_len(buf, len);                  \
})

convert xroad_time_t to SQL string representation (NULL, '10:10:10')

Parameters

[in] v - time to convert

Returns: SQL string

◆ xroad_time_to_str

#define xroad_time_to_str ( tm )

Value:

({                                                                              \
   char* buff = (char*)alloca(64);                                              \
   int32_t s = xroad_format(                                                    \
         buff, 64, "%02d:%02d:%02d", tm.hour, tm.min, tm.sec);                  \
   if (tm.usec)                                                                 \
   {                                                                            \
      s += xroad_format(buff + s, 64 - s, ".%D", tm.usec);                      \
   }                                                                            \
   if (tm.tz > 0)                                                               \
   {                                                                            \
      s += xroad_format(buff + s, 64 - s, " %P", xroad_tzone_get_name(tm.tz));  \
   }                                                                            \
   xroad_str_len(buff, s);                                                      \
})

convert time with timezone to string

Parameters

[in] tm - time to convert

Returns: string representation

Function Documentation

◆ xroad_now()

xroad_timestamp_t xroad_now ( )

Returns: now timestamp in microseconds

◆ xroad_now_monotonic()

xroad_timestamp_t xroad_now_monotonic ( void )

return monotonic time as clock_gettime(CLOCK_MONOTONIC_RAW)

Returns: monotonic timestamp

◆ xroad_now_nano()

xroad_timestamp_t xroad_now_nano ( )

Returns: now timestamp in nanoseconds

◆ xroad_now_sec()

xroad_timestamp_t xroad_now_sec ( )

Returns: now timestamp in seconds

◆ xroad_time_adjust()

xroad_time_t xroad_time_adjust	(	xroad_time_t	time,
		int64_t	usec
	)

adjust time to N microseconds

Parameters

[in]	time	- time to adjust
[in]	usec	- microseconds (can be negative)

Returns: adjusted time

◆ xroad_time_change_tz()

xroad_time_t xroad_time_change_tz	(	xroad_time_t	tm,
		xroad_tzone_t	new_tz
	)

change time timezone

Parameters

[in]	tm	- time to change
[in]	new_tz	- new timezone

Returns: time with new timezone

◆ xroad_time_cmp()

int64_t xroad_time_cmp	(	xroad_time_t	lhs,
		xroad_time_t	rhs
	)

compare two time values

Parameters

[in]	lhs	- left time value
[in]	rhs	- right time value

Returns: 0 - lhs == rhs, >0 - lhs > rhs, <0 - lhs < rhs

◆ xroad_time_create()

xroad_time_t xroad_time_create	(	uint8_t	hour,
		uint8_t	min,
		uint8_t	sec,
		uint32_t	usec,
		xroad_tzone_t	tz
	)

create time

Parameters

[in]	hour	- hour (0-24)
[in]	min	- minute (0-59)
[in]	sec	- second (0-59)
[in]	usec	- microseconds
[in]	tz	- tmezone, if any

Returns: xroad_time_t

◆ xroad_time_distance()

int64_t xroad_time_distance	(	xroad_time_t	a,
		xroad_time_t	b
	)

calculate difference between times, expressed in microseconds

Parameters

[in]	a	- time from
[in]	b	- time to return distance in microseconds

◆ xroad_time_from_str()

xroad_time_t xroad_time_from_str ( xroad_str_t time )

create time from string in format HH:MM:SS.UUUUUU

Parameters

[in] time - time in string

Returns: xroad_time_t instance

◆ xroad_time_from_ts()

xroad_time_t xroad_time_from_ts	(	xroad_timestamp_t	ts,
		xroad_tzone_t	tz
	)

get time from timestamp

Parameters

[in]	time	- time to convert
[in]	tz	- timezone

Returns: microseconds

◆ xroad_time_is_null()

bool xroad_time_is_null ( xroad_time_t time )

check if time is null

Parameters

[in] time - time

Returns: true if time is null

◆ xroad_time_max()

xroad_time_t xroad_time_max	(	xroad_time_t	a,
		xroad_time_t	b
	)

return maximum time of a and b

Parameters

[in]	a	- time
[in]	b	- time

Returns: maximum value

◆ xroad_time_min()

xroad_time_t xroad_time_min	(	xroad_time_t	a,
		xroad_time_t	b
	)

return minimum time of a and b

Parameters

[in]	a	- time
[in]	b	- time

Returns: minimum value

◆ xroad_time_now()

xroad_time_t xroad_time_now ( xroad_tzone_t tz )

get current time

Parameters

[in] tz - timezone. If 0, current tz used

Returns: current time

◆ xroad_time_start_of_day()

int64_t xroad_time_start_of_day ( time_t now )

Parameters

[in] now - timestamp in seconds, if NULL current timestamp will be given

Returns: EPOCH seconds to the begin of the current day

◆ xroad_time_to_ts()

xroad_timestamp_t xroad_time_to_ts ( xroad_time_t time )

convert time to timestamp using current date

Parameters

[in] time - time to convert

Returns: timestamp

◆ xroad_time_to_usec()

int64_t xroad_time_to_usec ( xroad_time_t time )

convert time to microseconds

Parameters

[in] time - time to convert

Returns: microseconds

Classes

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ xroad_time_to_sql

◆ xroad_time_to_str

Function Documentation

◆ xroad_now()

◆ xroad_now_monotonic()

◆ xroad_now_nano()

◆ xroad_now_sec()

◆ xroad_time_adjust()

◆ xroad_time_change_tz()

◆ xroad_time_cmp()

◆ xroad_time_create()

◆ xroad_time_distance()

◆ xroad_time_from_str()

◆ xroad_time_from_ts()

◆ xroad_time_is_null()

◆ xroad_time_max()

◆ xroad_time_min()

◆ xroad_time_now()

◆ xroad_time_start_of_day()

◆ xroad_time_to_ts()

◆ xroad_time_to_usec()