Author: Pekka Riikonen <priikone@silcnet.org>
- Copyright (C) 2003 - 2005 Pekka Riikonen
+ Copyright (C) 2003 - 2007 Pekka Riikonen
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
* DESCRIPTION
*
* This context represents time value. It includes date and time
- * down to millisecond precision.
+ * down to millisecond precision. The structure size is 64 bits.
*
* SOURCE
*
***/
typedef struct {
- unsigned int year : 13; /* Year, 0 - 8191 */
+ unsigned int year : 15; /* Year, 0 - 32768 */
unsigned int month : 4; /* Month, 1 - 12 */
unsigned int day : 5; /* Day, 1 - 31 */
unsigned int hour : 5; /* Hour, 0 - 23 */
unsigned int utc_minute : 6; /* Offset to Zulu (UTC) minutes */
unsigned int utc_east : 1; /* Offset, 1 east (+), 0 west (-) */
unsigned int dst : 1; /* Set if daylight saving time */
- /* 2 bits to spare */
} *SilcTime, SilcTimeStruct;
/***/
***/
SilcInt64 silc_time(void);
+/****f* silcutil/SilcTimeAPI/silc_time_msec
+ *
+ * SYNOPSIS
+ *
+ * SilcInt64 silc_time_msec(void);
+ *
+ * DESCRIPTION
+ *
+ * Returns the current time of the system since Epoch in millisecond
+ * resolution. Returns - 1 on error.
+ *
+ ***/
+SilcInt64 silc_time_msec(void);
+
+/****f* silcutil/SilcTimeAPI/silc_time_usec
+ *
+ * SYNOPSIS
+ *
+ * SilcInt64 silc_time_usec(void);
+ *
+ * DESCRIPTION
+ *
+ * Returns the current time of the system since Epoch in microsecond
+ * resolution. Returns - 1 on error.
+ *
+ ***/
+SilcInt64 silc_time_usec(void);
+
/****f* silcutil/SilcTimeAPI/silc_time_string
*
* SYNOPSIS
*
- * const char *silc_time_string(SilcInt64 timeval);
+ * const char *silc_time_string(SilcInt64 time_val_sec);
*
* DESCRIPTION
*
* Returns time and date as string. The caller must not free the string
* and next call to this function will delete the old string. If the
- * `timeval' is zero (0) returns current time as string, otherwise the
- * `timeval' as string. Returns NULL on error.
+ * `time_val_sec' is zero (0) returns current time as string, otherwise the
+ * `time_val_sec' as string. The `time_val_sec' is in seconds since Epoch.
+ * Returns NULL on error.
*
***/
-const char *silc_time_string(SilcInt64 timeval);
+const char *silc_time_string(SilcInt64 time_val_sec);
/****f* silcutil/SilcTimeAPI/silc_time_value
*
* SYNOPSIS
*
- * SilcBool silc_time_value(SilcInt64 timeval, SilcTime ret_time);
+ * SilcBool silc_time_value(SilcInt64 time_val_msec, SilcTime ret_time);
*
* DESCRIPTION
*
- * Returns time and date as SilcTime. If the `timeval' is zero (0)
- * returns current time as SilcTime, otherwise the `timeval' as SilcTime.
- * Returns FALSE on error, TRUE otherwise.
+ * Returns time and date as SilcTime. If the `time_val_msec' is zero (0)
+ * returns current time as SilcTime, otherwise the `time_val_msec' as
+ * SilcTime. The `time_val_msec' is in milliseconds since Epoch. Returns
+ * FALSE on error, TRUE otherwise.
*
***/
-SilcBool silc_time_value(SilcInt64 timeval, SilcTime ret_time);
+SilcBool silc_time_value(SilcInt64 time_val_msec, SilcTime ret_time);
/****f* silcutil/SilcTimeAPI/silc_time_universal
*
* SYNOPSIS
*
* SilcBool silc_time_universal(const char *universal_time,
- * SilcTime ret_time);
+ * SilcTime ret_time);
*
* DESCRIPTION
*
*
* SYNOPSIS
*
- * SilcBool silc_time_universal_string(SilcTime timeval, char *ret_string,
- * SilcUInt32 ret_string_size);
+ * SilcBool silc_time_universal_string(SilcTime time_val, char *ret_string,
+ * SilcUInt32 ret_string_size);
*
* DESCRIPTION
*
* `ret_string' buffer. Returns FALSE if the buffer is too small.
*
***/
-SilcBool silc_time_universal_string(SilcTime timeval, char *ret_string,
- SilcUInt32 ret_string_size);
+SilcBool silc_time_universal_string(SilcTime time_val, char *ret_string,
+ SilcUInt32 ret_string_size);
/****f* silcutil/SilcTimeAPI/silc_time_generalized
*
* SYNOPSIS
*
* SilcBool silc_time_generalized(const char *generalized_time,
- * SilcTime ret_time);
+ * SilcTime ret_time);
*
* DESCRIPTION
*
* silc_time_generalized("20030219190510.212Z", &ret_time);
*
***/
-SilcBool silc_time_generalized(const char *generalized_time, SilcTime ret_time);
+SilcBool
+silc_time_generalized(const char *generalized_time, SilcTime ret_time);
/****f* silcutil/SilcTimeAPI/silc_time_generalized_string
*
* SYNOPSIS
*
- * SilcBool silc_time_generalized_string(SilcTime timeval, char *ret_string,
- * SilcUInt32 ret_string_size);
+ * SilcBool silc_time_generalized_string(SilcTime time_val,
+ * char *ret_string,
+ * SilcUInt32 ret_string_size);
*
* DESCRIPTION
*
* `ret_string' buffer. Returns FALSE if the buffer is too small.
*
***/
-SilcBool silc_time_generalized_string(SilcTime timeval, char *ret_string,
- SilcUInt32 ret_string_size);
+SilcBool silc_time_generalized_string(SilcTime time_val, char *ret_string,
+ SilcUInt32 ret_string_size);
+
+/****f* silcutil/SilcTimeAPI/silc_compare_timeval
+ *
+ * SYNOPSIS
+ *
+ * SilcBool silc_compare_timeval(struct time_val *smaller,
+ * struct time_val *bigger)
+ *
+ * DESCRIPTION
+ *
+ * Compare two timeval structures and return TRUE if the first
+ * time value is smaller than the second time value.
+ *
+ ***/
+SilcBool silc_compare_timeval(struct timeval *smaller,
+ struct timeval *bigger);
+
+/****f* silcutil/SilcTimeAPI/silc_gettimeofday
+ *
+ * SYNOPSIS
+ *
+ * int silc_gettimeofday(struct timeval *p);
+ *
+ * DESCRIPTION
+ *
+ * Return current time to struct timeval. This function is system
+ * dependant. Returns 0 on success and -1 on error.
+ *
+ ***/
+int silc_gettimeofday(struct timeval *p);
#endif /* SILCTIME_H */
projects / silc.git / blobdiff