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