X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Flogger.h;h=2ea280be8b429cf596fe3ba6e129ea5c3d930313;hb=02220d48eec4dd3507b582031de639c9d7835ec8;hp=ca96ac242da27c3ef8df2a977c45251fb2f2bb15;hpb=dcbb0ae938711cd49df73dc2ff6cd6289aeefb44;p=user%2Fhenk%2Fcode%2Finspircd.git

diff --git a/include/logger.h b/include/logger.h
index ca96ac242..2ea280be8 100644
--- a/include/logger.h
+++ b/include/logger.h
@@ -1,30 +1,37 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
+ *
+ *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
+ *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
  *
- *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
- * See: http://wiki.inspircd.org/Credits
+ * This file is part of InspIRCd.  InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
  *
- * This program is free but copyrighted software; see
- *            the file COPYING for details.
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
  *
- * ---------------------------------------------------
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#ifndef __LOGMANAGER_H
-#define __LOGMANAGER_H
-
-/** This class implements a nonblocking writer.
- * Most people writing an ircd give little thought to their disk
- * i/o. On a congested system, disk writes can block for long
- * periods of time (e.g. if the system is busy and/or swapping
- * a lot). If we just use a blocking fprintf() call, this could
- * block for undesirable amounts of time (half of a second through
- * to whole seconds). We DO NOT want this, so we make our logfile
- * nonblocking and hook it into the SocketEngine.
- * NB: If the operating system does not support nonblocking file
- * I/O (linux seems to, as does freebsd) this will default to
- * blocking behaviour.
+
+#pragma once
+
+/** Levels at which messages can be logged. */
+enum LogLevel
+{
+	LOG_RAWIO   = 5,
+	LOG_DEBUG   = 10,
+	LOG_VERBOSE = 20,
+	LOG_DEFAULT = 30,
+	LOG_SPARSE  = 40,
+	LOG_NONE    = 50
+};
+
+/** Simple wrapper providing periodic flushing to a disk-backed file.
  */
 class CoreExport FileWriter
 {
@@ -80,9 +87,11 @@ class CoreExport FileWriter
 class CoreExport LogStream : public classbase
 {
  protected:
-	int loglvl;
+	LogLevel loglvl;
  public:
-	LogStream(int loglevel) : loglvl(loglevel)
+	static const char LogHeader[];
+
+	LogStream(LogLevel loglevel) : loglvl(loglevel)
 	{
 	}
 
@@ -94,13 +103,13 @@ class CoreExport LogStream : public classbase
 	/** Changes the loglevel for this LogStream on-the-fly.
 	 * This is needed for -nofork. But other LogStreams could use it to change loglevels.
 	 */
-	void ChangeLevel(int lvl) { this->loglvl = lvl; }
+	void ChangeLevel(LogLevel lvl) { this->loglvl = lvl; }
 
 	/** Called when there is stuff to log for this particular logstream. The derived class may take no action with it, or do what it
 	 * wants with the output, basically. loglevel and type are primarily for informational purposes (the level and type of the event triggered)
 	 * and msg is, of course, the actual message to log.
 	 */
-	virtual void OnLog(int loglevel, const std::string &type, const std::string &msg) = 0;
+	virtual void OnLog(LogLevel loglevel, const std::string &type, const std::string &msg) = 0;
 };
 
 typedef std::map<FileWriter*, int> FileLogMap;
@@ -130,7 +139,6 @@ class CoreExport LogManager
 	FileLogMap FileLogs;
 
  public:
-
 	LogManager();
 	~LogManager();
 
@@ -163,7 +171,7 @@ class CoreExport LogManager
 		}
 	}
 
-	/** Opens all logfiles defined in the configuration file using <log method="file">.
+	/** Opens all logfiles defined in the configuration file using \<log method="file">.
 	 */
 	void OpenFileLogs();
 
@@ -202,17 +210,15 @@ class CoreExport LogManager
 
 	/** Logs an event, sending it to all LogStreams registered for the type.
 	 * @param type Log message type (ex: "USERINPUT", "MODULE", ...)
-	 * @param loglevel Log message level (DEBUG, VERBOSE, DEFAULT, SPARSE, NONE)
+	 * @param loglevel Log message level (LOG_DEBUG, LOG_VERBOSE, LOG_DEFAULT, LOG_SPARSE, LOG_NONE)
 	 * @param msg The message to be logged (literal).
 	 */
-	void Log(const std::string &type, int loglevel, const std::string &msg);
+	void Log(const std::string &type, LogLevel loglevel, const std::string &msg);
 
 	/** Logs an event, sending it to all LogStreams registered for the type.
 	 * @param type Log message type (ex: "USERINPUT", "MODULE", ...)
-	 * @param loglevel Log message level (DEBUG, VERBOSE, DEFAULT, SPARSE, NONE)
-	 * @param msg The format of the message to be logged. See your C manual on printf() for details.
+	 * @param loglevel Log message level (LOG_DEBUG, LOG_VERBOSE, LOG_DEFAULT, LOG_SPARSE, LOG_NONE)
+	 * @param fmt The format of the message to be logged. See your C manual on printf() for details.
 	 */
-	void Log(const std::string &type, int loglevel, const char *fmt, ...) CUSTOM_PRINTF(4, 5);
+	void Log(const std::string &type, LogLevel loglevel, const char *fmt, ...) CUSTOM_PRINTF(4, 5);
 };
-
-#endif