X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=include%2Fyaz%2Flog.h;h=bd4d516f8020ecba479391ee50a1ff1714808016;hb=8d57c383d5f05e759cb31b33a5b78b3cea2033d6;hp=ca2a36eccb550d5f87859f94f3c798d07719531a;hpb=6dc4539f74395fa8f95596263d86edc1281bc399;p=yaz-moved-to-github.git

diff --git a/include/yaz/log.h b/include/yaz/log.h
index ca2a36e..bd4d516 100644
--- a/include/yaz/log.h
+++ b/include/yaz/log.h
@@ -23,7 +23,12 @@
  * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  * OF THIS SOFTWARE.
  *
- * $Id: log.h,v 1.11 2003-05-22 15:41:58 heikki Exp $
+ * $Id: log.h,v 1.16 2004-11-03 14:25:06 heikki Exp $
+ */
+
+/**
+ * \file log.h
+ * \brief Header for logging utility
  */
 
 #ifndef LOG_H
@@ -35,37 +40,88 @@
 
 YAZ_BEGIN_CDECL
 
-#define LOG_FATAL  0x0001
-#define LOG_DEBUG  0x0002
-#define LOG_WARN   0x0004
-#define LOG_LOG    0x0008
-#define LOG_ERRNO  0x0010     /* append strerror to message */
-#define LOG_FILE   0x0020
-#define LOG_APP    0x0040     /* For application level events such as new-connection */
-#define LOG_MALLOC 0x0080     /* debugging mallocs */
-#define LOG_NOTIME 0x0100     /* do not output date and time */
-#define LOG_APP2   0x0200     /* For application-level events, such as api calls */
-#define LOG_APP3   0x0400     /* For more application-level events */
+#define LOG_FATAL  0x00000001
+#define LOG_DEBUG  0x00000002
+#define LOG_WARN   0x00000004
+#define LOG_LOG    0x00000008
+#define LOG_ERRNO  0x00000010 /* append strerror to message */
+#define LOG_FILE   0x00000020
+#define LOG_APP    0x00000040 /* Application level events (new-connection) */
+#define LOG_MALLOC 0x00000080 /* debugging mallocs */
+#define LOG_NOTIME 0x00000100 /* do not output date and time */
+#define LOG_APP2   0x00000200 /* Application-level events, such as api calls */
+#define LOG_APP3   0x00000400 /* For more application-level events */
+#define LOG_FLUSH  0x00000800 /* Flush log after every write (DEBUG does too) */
 
 #define LOG_ALL   (0xffff&~LOG_MALLOC&~LOG_NOTIME)
 
 #define LOG_DEFAULT_LEVEL (LOG_FATAL | LOG_ERRNO | LOG_LOG | LOG_WARN)
 
+#define LOG_LAST_BIT LOG_FLUSH  /* the last bit used for regular log bits */
+                                /* the rest are for dynamic modules */
+
 #define logf yaz_log
 
+/** 
+ * yaz_log_init is a shorthand for initializing the log level and prefixes */
 YAZ_EXPORT void yaz_log_init(int level, const char *prefix, const char *name);
+
+/** yaz_log_init_file sets the file name used for yaz_log */
 YAZ_EXPORT void yaz_log_init_file (const char *fname);
+
+/** yaz_log_init_level sets the logging level. Use an OR of the bits above */
 YAZ_EXPORT void yaz_log_init_level (int level);
+
+/** yaz_log_init_prefix sets the log prefix */
 YAZ_EXPORT void yaz_log_init_prefix (const char *prefix);
+
+/** yaz_log_init_prefix2 sets an optional second prefix */
 YAZ_EXPORT void yaz_log_init_prefix2 (const char *prefix);
 
+/** 
+ * yaz_log_time_format sets the format of the timestamp. See man 3 strftime 
+ * Calling with "old" sets to the old format "11:55:06-02/11"
+ * Calling with NULL or "" sets to the new format "20041102-115719"
+ * If not called at all, the old format is used, for backward compatibility
+ */
+YAZ_EXPORT void yaz_log_time_format(const char *fmt);
+
+/** 
+ * yaz_log_init_max_size sets the max size for a log file. 
+ * zero means no limit. Negative means built-in limit (1GB)
+ */
+YAZ_EXPORT void yaz_log_init_max_size(int mx);
+
+/**
+ * yaz_log writes an entry in the log. Defaults to stderr if not initialized
+ * to a file with yaz_log_init_file. The level must match the level set via
+ * yaz_log_init_level, optionally defined via yaz_log_mask_str. */
 YAZ_EXPORT void yaz_log(int level, const char *fmt, ...)
 #ifdef __GNUC__
 	__attribute__ ((format (printf, 2, 3)))
 #endif
 	;
+
+/** 
+ * yaz_log_mask_str converts a comma-separated list of log levels to a bit 
+ * mask. Starts from default level, and adds bits as specified, unless 'none'
+ * is specified, which clears the list. If a name matches the name of a
+ * LOG_BIT above, that one is set. Otherwise a new value is picked, and given
+ * to that name, to be found with yaz_log_module_level */
 YAZ_EXPORT int yaz_log_mask_str (const char *str);
+
+/** yaz_log_mask_str_x is like yaz_log_mask_str, but with a given start value*/
 YAZ_EXPORT int yaz_log_mask_str_x (const char *str, int level);
+
+/** 
+ * yaz_log_module_level returns a log level mask corresponding to the module
+ * name. If that had been specified on the -v arguments (that is, passed to
+ * yaz_log_mask_str), then a non-zero mask is returned. If not, we get a 
+ * zero. This can later be used in yaz_log for the level argument
+ */
+YAZ_EXPORT int yaz_log_module_level(const char *name);
+
+/** yaz_log_file returns the file handle for yaz_log. */
 YAZ_EXPORT FILE *yaz_log_file(void);
 
 YAZ_EXPORT void log_event_start (void (*func)(int level, const char *msg, void *info),
@@ -73,6 +129,7 @@ YAZ_EXPORT void log_event_start (void (*func)(int level, const char *msg, void *
 YAZ_EXPORT void log_event_end (void (*func)(int level, const char *msg, void *info),
 	void *info);
 
+YAZ_EXPORT void yaz_log_reopen(void);
 YAZ_END_CDECL
 
 #endif