include/core.h

   1 /* $Id$                     */
   2
   3 /* gras/core.h - Unsorted part of the GRAS public interface                 */
   4
   5 /* Authors: Martin Quinson                                                  */
   6 /* Copyright (C) 2003 the OURAGAN project.                                  */
   7
   8 /* This program is free software; you can redistribute it and/or modify it
   9    under the terms of the license (GNU LGPL) which comes with this package. */
  10
  11 #ifndef GRAS_CORE_H
  12 #define GRAS_CORE_H
  13
  14 #include <stddef.h>    /* offsetof() */
  15 #include <sys/types.h>  /* size_t */
  16 #include <stdarg.h>
  17
  18
  19 /*! C++ users need love */
  20 #ifndef BEGIN_DECL
  21 # ifdef __cplusplus
  22 #  define BEGIN_DECL extern "C" {
  23 # else
  24 #  define BEGIN_DECL
  25 # endif
  26 #endif
  27
  28 /*! C++ users need love */
  29 #ifndef END_DECL
  30 # ifdef __cplusplus
  31 #  define END_DECL }
  32 # else
  33 #  define END_DECL
  34 # endif
  35 #endif
  36 /* End of cruft for C++ */
  37
  38 BEGIN_DECL
  39
  40 /* **************************************************************************
  41  * Garbage collection support
  42  * **************************************************************************/
  43 typedef enum { free_after_use, free_never } e_gras_free_directive_t;
  44
  45
  46 /* **************************************************************************
  47  * Wrappers over OS functions
  48  * **************************************************************************/
  49
  50 /**
  51  * gras_get_my_fqdn:
  52  *
  53  * Returns the fully-qualified name of the host machine, or NULL if the name
  54  * cannot be determined.  Always returns the same value, so multiple calls
  55  * cause no problems.
  56  */
  57 const char *
  58 gras_get_my_fqdn(void);
  59
  60 /**
  61  * gras_time:
  62  *
  63  * Get the time in number of second since the Epoch.
  64  * (00:00:00 UTC, January 1, 1970 in Real Life, and begining of simulation in SG)
  65  */
  66 double gras_time(void);
  67
  68 /**
  69  * gras_sleep:
  70  * @sec: number of seconds to sleep
  71  * @usec: number of microseconds to sleep
  72  *
  73  * sleeps for the given amount of seconds plus the given amount of microseconds.
  74  */
  75 void gras_sleep(unsigned long sec, unsigned long usec);
  76
  77 END_DECL
  78
  79 #endif /* GRAS_CORE_H */
  80