lib/silcutil/silctime.h

   1 /*
   2
   3   silctime.h
   4
   5   Author: Pekka Riikonen <priikone@silcnet.org>
   6
   7   Copyright (C) 2003 - 2006 Pekka Riikonen
   8
   9   This program is free software; you can redistribute it and/or modify
  10   it under the terms of the GNU General Public License as published by
  11   the Free Software Foundation; version 2 of the License.
  12
  13   This program is distributed in the hope that it will be useful,
  14   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16   GNU General Public License for more details.
  17
  18 */
  19
  20 /****h* silcutil/SILC Time Interface
  21  *
  22  * DESCRIPTION
  23  *
  24  * This interface provides various utility functions for getting current
  25  * time and converting different time representations into the SilcTime
  26  * representation.
  27  *
  28  ***/
  29
  30 #ifndef SILCTIME_H
  31 #define SILCTIME_H
  32
  33 /****s* silcutil/SilcTimeAPI/SilcTime
  34  *
  35  * NAME
  36  *
  37  *    typedef struct { ... } *SilcTime, SilcTimeStruct;
  38  *
  39  * DESCRIPTION
  40  *
  41  *    This context represents time value.  It includes date and time
  42  *    down to millisecond precision.  The structure size is 64 bits.
  43  *
  44  * SOURCE
  45  *
  46  ***/
  47 typedef struct {
  48   unsigned int year       : 15;    /* Year,     0 - 32768 */
  49   unsigned int month      : 4;     /* Month,    1 - 12 */
  50   unsigned int day        : 5;     /* Day,      1 - 31 */
  51   unsigned int hour       : 5;     /* Hour,     0 - 23 */
  52   unsigned int minute     : 6;     /* Minute,   0 - 59 */
  53   unsigned int second     : 6;     /* Second,   0 - 61 */
  54   unsigned int msecond    : 10;    /* Millisec, 0 - 1000 */
  55   unsigned int utc_hour   : 5;     /* Offset to Zulu (UTC) hours */
  56   unsigned int utc_minute : 6;     /* Offset to Zulu (UTC) minutes */
  57   unsigned int utc_east   : 1;     /* Offset, 1 east (+), 0 west (-) */
  58   unsigned int dst        : 1;     /* Set if daylight saving time */
  59 } *SilcTime, SilcTimeStruct;
  60 /***/
  61
  62 /****f* silcutil/SilcTimeAPI/silc_time
  63  *
  64  * SYNOPSIS
  65  *
  66  *    SilcInt64 silc_time(void);
  67  *
  68  * DESCRIPTION
  69  *
  70  *    Returns the current time of the system since Epoch.  The returned
  71  *    value is seconds since Epoch (1.1.1970).  Returns -1 on error.
  72  *
  73  ***/
  74 SilcInt64 silc_time(void);
  75
  76 /****f* silcutil/SilcTimeAPI/silc_time_msec
  77  *
  78  * SYNOPSIS
  79  *
  80  *    SilcInt64 silc_time_msec(void);
  81  *
  82  * DESCRIPTION
  83  *
  84  *    Returns the current time of the system since Epoch in millisecond
  85  *    resolution.  Returns - 1 on error.
  86  *
  87  ***/
  88 SilcInt64 silc_time_msec(void);
  89
  90 /****f* silcutil/SilcTimeAPI/silc_time_usec
  91  *
  92  * SYNOPSIS
  93  *
  94  *    SilcInt64 silc_time_usec(void);
  95  *
  96  * DESCRIPTION
  97  *
  98  *    Returns the current time of the system since Epoch in microsecond
  99  *    resolution.  Returns - 1 on error.
 100  *
 101  ***/
 102 SilcInt64 silc_time_usec(void);
 103
 104 /****f* silcutil/SilcTimeAPI/silc_time_string
 105  *
 106  * SYNOPSIS
 107  *
 108  *    const char *silc_time_string(SilcInt64 time_val);
 109  *
 110  * DESCRIPTION
 111  *
 112  *    Returns time and date as string.  The caller must not free the string
 113  *    and next call to this function will delete the old string.  If the
 114  *    `time_val' is zero (0) returns current time as string, otherwise the
 115  *    `time_val' as string.  The `time_val' is in seconds since Epoch.
 116  *    Returns NULL on error.
 117  *
 118  ***/
 119 const char *silc_time_string(SilcInt64 time_val);
 120
 121 /****f* silcutil/SilcTimeAPI/silc_time_value
 122  *
 123  * SYNOPSIS
 124  *
 125  *   SilcBool silc_time_value(SilcInt64 time_val, SilcTime ret_time);
 126  *
 127  * DESCRIPTION
 128  *
 129  *    Returns time and date as SilcTime.  If the `time_val' is zero (0)
 130  *    returns current time as SilcTime, otherwise the `time_val' as SilcTime.
 131  *    The `time_val' is in milliseconds since Epoch.  Returns FALSE on error,
 132  *    TRUE otherwise.
 133  *
 134  ***/
 135 SilcBool silc_time_value(SilcInt64 time_val, SilcTime ret_time);
 136
 137 /****f* silcutil/SilcTimeAPI/silc_time_universal
 138  *
 139  * SYNOPSIS
 140  *
 141  *    SilcBool silc_time_universal(const char *universal_time,
 142  *                                 SilcTime ret_time);
 143  *
 144  * DESCRIPTION
 145  *
 146  *    Returns time and date as SilcTime from `universal_time' string which
 147  *    format is "YYMMDDhhmmssZ", where YY is year, MM is month, DD is day,
 148  *    hh is hour, mm is minutes, ss is seconds and Z is timezone, which
 149  *    by default is Zulu (UTC).  Universal time is defined in ISO/EIC 8824-1.
 150  *
 151  *    Returns FALSE on error, TRUE otherwise.
 152  *
 153  * EXAMPLE
 154  *
 155  *    SilcTimeStruct ret_time;
 156  *
 157  *    time is 03/02/19 19:04:03 Zulu (UTC)
 158  *    silc_time_universal("030219190403Z", &ret_time);
 159  *
 160  ***/
 161 SilcBool silc_time_universal(const char *universal_time, SilcTime ret_time);
 162
 163 /****f* silcutil/SilcTimeAPI/silc_time_universal_string
 164  *
 165  * SYNOPSIS
 166  *
 167  *    SilcBool silc_time_universal_string(SilcTime time_val, char *ret_string,
 168  *                                        SilcUInt32 ret_string_size);
 169  *
 170  * DESCRIPTION
 171  *
 172  *    Encodes the SilcTime `time' into the universal time format into the
 173  *    `ret_string' buffer.  Returns FALSE if the buffer is too small.
 174  *
 175  ***/
 176 SilcBool silc_time_universal_string(SilcTime time_val, char *ret_string,
 177                                     SilcUInt32 ret_string_size);
 178
 179 /****f* silcutil/SilcTimeAPI/silc_time_generalized
 180  *
 181  * SYNOPSIS
 182  *
 183  *    SilcBool silc_time_generalized(const char *generalized_time,
 184  *                                   SilcTime ret_time);
 185  *
 186  * DESCRIPTION
 187  *
 188  *    Returns time and date as SilcTime from `generalized_time' string which
 189  *    format is "YYYYMMDDhhmmss.ppZ", where YYYY is year, MM is month, DD
 190  *    is day, hh is hour, mm is minutes, ss is seconds which may have optional
 191  *    precision pp, and Z is timezone, which by default is Zulu (UTC).
 192  *    Generalized time is defined in ISO/EIC 8824-1.
 193  *
 194  *    Returns FALSE on error, TRUE otherwise.
 195  *
 196  * EXAMPLE
 197  *
 198  *    SilcTimeStruct ret_time;
 199  *
 200  *    time is 2003/02/19 19:04:03 Zulu (UTC)
 201  *    silc_time_generalized("20030219190403Z", &ret_time);
 202  *
 203  *    time is 2003/02/19 19:05:10.212 Zulu (UTC)
 204  *    silc_time_generalized("20030219190510.212Z", &ret_time);
 205  *
 206  ***/
 207 SilcBool
 208 silc_time_generalized(const char *generalized_time, SilcTime ret_time);
 209
 210 /****f* silcutil/SilcTimeAPI/silc_time_generalized_string
 211  *
 212  * SYNOPSIS
 213  *
 214  *    SilcBool silc_time_generalized_string(SilcTime time_val,
 215  *                                          char *ret_string,
 216  *                                          SilcUInt32 ret_string_size);
 217  *
 218  * DESCRIPTION
 219  *
 220  *    Encodes the SilcTime `time' into the generalized time format into the
 221  *    `ret_string' buffer.  Returns FALSE if the buffer is too small.
 222  *
 223  ***/
 224 SilcBool silc_time_generalized_string(SilcTime time_val, char *ret_string,
 225                                       SilcUInt32 ret_string_size);
 226
 227 /****f* silcutil/SilcTimeAPI/silc_compare_timeval
 228  *
 229  * SYNOPSIS
 230  *
 231  *    SilcBool silc_compare_timeval(struct time_val *smaller,
 232  *                                  struct time_val *bigger)
 233  *
 234  * DESCRIPTION
 235  *
 236  *    Compare two timeval structures and return TRUE if the first
 237  *    time value is smaller than the second time value.
 238  *
 239  ***/
 240 SilcBool silc_compare_timeval(struct timeval *smaller,
 241                               struct timeval *bigger);
 242
 243 /****f* silcutil/SilcTimeAPI/silc_gettimeofday
 244  *
 245  * SYNOPSIS
 246  *
 247  *    int silc_gettimeofday(struct timeval *p);
 248  *
 249  * DESCRIPTION
 250  *
 251  *    Return current time to struct timeval.  This function is system
 252  *    dependant.  Returns 0 on success and -1 on error.
 253  *
 254  ***/
 255 int silc_gettimeofday(struct timeval *p);
 256
 257 #endif /* SILCTIME_H */