Added SILC Thread Queue API

[silc.git] / lib / silcutil / silctime.h

diff --git a/lib/silcutil/silctime.h b/lib/silcutil/silctime.h
index c7494bafa9dc98d9cd124ee73f5d28941059dc3d..e01e1ae701f92660debb212b10dae7a6195f7b86 100644 (file)
--- a/lib/silcutil/silctime.h
+++ b/lib/silcutil/silctime.h
@@ -4,7 +4,7 @@
 
   Author: Pekka Riikonen <priikone@silcnet.org>
 
-  Copyright (C) 2003 - 2006 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
@@ -44,7 +44,7 @@
  * SOURCE
  *
  ***/
-typedef struct {
+typedef struct SilcTimeObject {
   unsigned int year       : 15;           /* Year,     0 - 32768 */
   unsigned int month      : 4;    /* Month,    1 - 12 */
   unsigned int day        : 5;    /* Day,      1 - 31 */
@@ -105,34 +105,53 @@ SilcInt64 silc_time_usec(void);
  *
  * SYNOPSIS
  *
- *    const char *silc_time_string(SilcInt64 time_val);
+ *    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
- *    `time_val' is zero (0) returns current time as string, otherwise the
- *    `time_val' as string.  The `time_val' is in seconds since Epoch.
+ *    `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 time_val);
+const char *silc_time_string(SilcInt64 time_val_sec);
 
 /****f* silcutil/SilcTimeAPI/silc_time_value
  *
  * SYNOPSIS
  *
- *   SilcBool silc_time_value(SilcInt64 time_val, SilcTime ret_time);
+ *   SilcBool silc_time_value(SilcInt64 time_val_msec, SilcTime ret_time);
  *
  * DESCRIPTION
  *
- *    Returns time and date as SilcTime.  If the `time_val' is zero (0)
- *    returns current time as SilcTime, otherwise the `time_val' as SilcTime.
- *    The `time_val' is in milliseconds since Epoch.  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 time_val, SilcTime ret_time);
+SilcBool silc_time_value(SilcInt64 time_val_msec, SilcTime ret_time);
+
+/****f* silcutil/SilcTimeAPI/silc_timezone
+ *
+ * SYNOPSIS
+ *
+ *    SilcBool silc_timezone(char *timezone, SilcUInt32 timezone_size);
+ *
+ * DESCRIPTION
+ *
+ *    Returns current timezone in Universal time format into the `timezone'
+ *    buffer of size of `timezone_size'.  The possible values this function
+ *    returns are: Z (For UTC timezone), +hh (UTC + hours) -hh (UTC - hours),
+ *    +hh:mm (UTC + hours:minutes) or -hh:mm (UTC - hours:minutes).  The
+ *    returned values are always offsets to UTC.
+ *
+ *    Returns FALSE on error, TRUE otherwise.
+ *
+ ***/
+SilcBool silc_timezone(char *timezone, SilcUInt32 timezone_size);
 
 /****f* silcutil/SilcTimeAPI/silc_time_universal
  *
@@ -228,17 +247,16 @@ SilcBool silc_time_generalized_string(SilcTime time_val, char *ret_string,
  *
  * SYNOPSIS
  *
- *    SilcBool silc_compare_timeval(struct time_val *smaller,
- *                                  struct time_val *bigger)
+ *    int silc_compare_timeval(struct time_val *t1, struct time_val *t2);
  *
  * DESCRIPTION
  *
- *    Compare two timeval structures and return TRUE if the first
- *    time value is smaller than the second time value.
+ *    Compares `t1' and `t2' time structures and returns less than zero,
+ *    zero or more than zero when `t1' is smaller, equal or bigger than
+ *    `t2', respectively.
  *
  ***/
-SilcBool silc_compare_timeval(struct timeval *smaller,
-                             struct timeval *bigger);
+int silc_compare_timeval(struct timeval *t1, struct timeval *t2);
 
 /****f* silcutil/SilcTimeAPI/silc_gettimeofday
  *
@@ -254,4 +272,47 @@ SilcBool silc_compare_timeval(struct timeval *smaller,
  ***/
 int silc_gettimeofday(struct timeval *p);
 
+/****f* silcutil/SilcTimeAPI/silc_usleep
+ *
+ * SYNOPSIS
+ *
+ *    void silc_usleep(unsigned long microseconds);
+ *
+ * DESCRIPTION
+ *
+ *    Delays the execution of process/thread for the specified amount of
+ *    time, which is in microseconds.
+ *
+ * NOTES
+ *
+ *    The delay is only approximate and on some platforms the resolution is
+ *    in fact milliseconds.
+ *
+ ***/
+static inline
+void silc_usleep(unsigned long microseconds)
+{
+#ifdef SILC_UNIX
+#ifdef HAVE_NANOSLEEP
+  struct timespec tv;
+  tv.tv_sec = 0;
+  tv.tv_nsec = microseconds * 1000;
+#endif /* HAVE_NANOSLEEP */
+#endif /* SILC_UNIX */
+
+#ifdef SILC_UNIX
+#ifdef HAVE_NANOSLEEP
+  nanosleep(&tv, NULL);
+#else
+  usleep(microseconds);
+#endif /* HAVE_NANOSLEEP */
+#endif /* SILC_UNIX */
+#ifdef SILC_WIN32
+  Sleep(microseconds / 1000);
+#endif /* SILC_WIN32 */
+#ifdef SILC_SYMBIAN
+  silc_symbian_usleep(microseconds);
+#endif /* SILC_SYMBIAN */
+}
+
 #endif /* SILCTIME_H */