include/gw-log.h

   1 /*
   2  * gw-log.h: Logging facilities.
   3  *
   4  * Europagate, 1994-1995.
   5  *
   6  * $Log: gw-log.h,v $
   7  * Revision 1.4  1995/03/27 12:50:40  adam
   8  * New level: GW_LOG_ERRNO.
   9  *
  10  * Revision 1.3  1995/02/23  08:32:11  adam
  11  * Changed header.
  12  *
  13  * Revision 1.1.1.1  1995/02/09  17:27:12  adam
  14  * Initial version of email gateway under CVS control.
  15  *
  16  * Initial:       Dec  7, 94 (Adam Dickmeiss)
  17  */
  18
  19 #ifndef GW_LOG_H
  20 #define GW_LOG_H
  21 /* The log level is an unsigned integer value with at least 16 bits */
  22
  23 /* The log levels are defined below */
  24 #define GW_LOG_FATAL 0x01
  25 #define GW_LOG_WARN  0x02
  26 #define GW_LOG_ACCT  0x04
  27 #define GW_LOG_STAT  0x08
  28 #define GW_LOG_ERRNO 0x10
  29
  30 /* All debug levels */
  31 #define GW_LOG_DEBUG 0xfff0
  32 /* Individual debug levels, x sould be in range 0-10 */
  33 #define GW_LOG_DEBUGN(x) (0x20<<(x))
  34
  35 /* All levels on / All levels except debugging */
  36 #define GW_LOG_ALL   0xffff
  37 #define GW_LOG_DEFAULT 0x0f
  38
  39 void gw_log_init (const char *app_name);
  40 /*
  41    Initialises the log-system. Application name is given by 'app_name' -
  42    could be specified as argv[0]. The application name should not
  43    contain blanks!
  44
  45    All log messages are directed to stderr on return from this function.
  46    Override this behaviour by using the gw_log_file function.
  47
  48    The log level is set to GW_LOG_DEFAULT. Override this with the
  49    gw_log_level function.
  50
  51    The session id is set to 0. Use gw_log_session to change this.
  52  */
  53
  54 void gw_log_level (unsigned level);
  55 /*
  56    Sets the log to 'level' by using the GW_LOG_xxxx masks as described
  57    above.
  58  */
  59
  60 void gw_log_session (int session);
  61 /*
  62    Sets the session id to 'session'.
  63  */
  64
  65 int gw_log_file (unsigned level, const char *fname);
  66 /*
  67    Specifies that output given by 'level' should be appended to file 'fname'.
  68    Thus, all log messages can be written to one file or several files.
  69    If 'level' is GW_LOG_ALL all output is appended to the same file.
  70    If 'fname' is NULL it means that the output is written to stderr.
  71    If 'fname' is "" it means the output is written to stdout.
  72
  73    This function returns 0 on success; -1 on failure.
  74  */
  75
  76 int gw_log (unsigned level, const char *event_type, const char *format, ...);
  77 /*
  78    Append log message to one or more files. The value of parameter
  79    'level' and the value given by the last gw_log_level call are bitwise
  80    AND'ed. This value represents the log level for this message.
  81    If this value is non-zero the 'event_type' and 'format' are used to
  82    create the log entries which are appended to the log files specified by
  83    the gw_log_file call(s).
  84
  85    The 'event_type' should not contain blanks.
  86    This function returns 0 on success; -1 on failure.
  87  */
  88
  89 char *gw_strdup (const char *s);
  90 /*
  91    Works as strdup(3s), which is not defined by ANSI.
  92  */
  93
  94
  95 /* log file format:
  96    <appname> <session> <date> <level> <type> <parameter>
  97
  98    Assuming that a 'token' is separated by one or more blanks we have:
  99
 100    <appname>   one token
 101    <session>   one token
 102    <date>      one token yymmddhhmmss
 103    <level>     one token
 104    <type>      one token
 105
 106    <parameter> zero or more tokens.
 107  */
 108 #endif