aboutsummaryrefslogtreecommitdiffstats
path: root/Source/charon/utils/logger_manager.h
diff options
context:
space:
mode:
Diffstat (limited to 'Source/charon/utils/logger_manager.h')
-rw-r--r--Source/charon/utils/logger_manager.h140
1 files changed, 140 insertions, 0 deletions
diff --git a/Source/charon/utils/logger_manager.h b/Source/charon/utils/logger_manager.h
new file mode 100644
index 000000000..4a2707732
--- /dev/null
+++ b/Source/charon/utils/logger_manager.h
@@ -0,0 +1,140 @@
+/**
+ * @file logger_manager.h
+ *
+ * @brief Logger manager. Manages globaly all logger objects
+ *
+ */
+
+/*
+ * Copyright (C) 2005 Jan Hutter, Martin Willi
+ * Hochschule fuer Technik Rapperswil
+ *
+ * This program 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; either version 2 of the License, or (at your
+ * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
+ *
+ * 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.
+ */
+
+#ifndef LOGGER_MANAGER_H_
+#define LOGGER_MANAGER_H_
+
+#include <pthread.h>
+
+#include "logger.h"
+
+/**
+ * @brief Context of a specific logger
+ */
+typedef enum logger_context_e logger_context_t;
+
+enum logger_context_e{
+ PARSER,
+ GENERATOR,
+ IKE_SA,
+ MESSAGE,
+ THREAD_POOL,
+ WORKER_THREAD,
+ EVENT_THREAD,
+ SENDER_THREAD,
+ RECEIVER_THREAD,
+ TESTER,
+};
+
+
+/**
+ * @brief The logger_manager_t object
+ */
+typedef struct logger_manager_s logger_manager_t;
+
+struct logger_manager_s {
+
+ /**
+ * @brief Gets a logger_t object for a specific logger context.
+ *
+ * @warning logger_t objects which are not destroyed over function
+ * #logger_manager_s.destroy_logger are destroyed in logger_managers
+ * destroy function. Don't use logger_t's own destroy function with
+ * managed logger_t objects.
+ *
+ * @param this logger_manager_t object
+ * @param context logger_context to use the logger for.
+ * @param[out] logger pointer to a a place where the new logger is stored
+ * @param name name for the new logger. Context name is already included
+ * and has not to be specified.
+ * @return
+ * - logger_t on SUCCESS
+ * - NULL otherwise
+ */
+ logger_t *(*create_logger) (logger_manager_t *this, logger_context_t context, char *name);
+
+
+ /**
+ * @brief Destroys a logger_t object which is not used anymore
+ *
+ * @warning logger_t objects which are not destroyed over function
+ * #logger_manager_s.destroy_logger are destroyed in logger_managers
+ * destroy function.
+ *
+ * @param this logger_manager_t object
+ * @param logger pointer to the logger which has to be destroyed
+ * @return
+ * - SUCCESS
+ * - OUT_OF_RES
+ * - NOT_FOUND
+ */
+ status_t (*destroy_logger) (logger_manager_t *this,logger_t *logger);
+
+ /**
+ * Returns the set logger_level of a specific context or 0.
+ * @param this calling object
+ * @param context context to check level
+ * @return logger_level for the given logger_context
+ */
+ logger_level_t (*get_logger_level) (logger_manager_t *this, logger_context_t context);
+
+ /**
+ * Enables a logger_level of a specific context.
+ * @param this calling object
+ * @param context context to set level
+ * @param logger_level logger_level to eanble
+ * @return SUCCESS
+ */
+ status_t (*enable_logger_level) (logger_manager_t *this, logger_context_t context,logger_level_t logger_level);
+
+
+ /**
+ * Disables a logger_level of a specific context.
+ * @param this calling object
+ * @param context context to set level
+ * @param logger_level logger_level to disable
+ * @return SUCCESS
+ */
+ status_t (*disable_logger_level) (logger_manager_t *this, logger_context_t context,logger_level_t logger_level);
+
+
+ /**
+ * @brief destroys a logger_manager_t object.
+ *
+ * @param this logger_manager_t object
+ * @return
+ * - SUCCESS in any case
+ */
+ status_t (*destroy) (logger_manager_t *this);
+};
+
+/**
+ * @brief Constructor to create a logger_manager_t object.
+ *
+ * @param default_log_level default log level for a context
+ * @return logger_manager_t object or NULL if failed
+ *
+ */
+logger_manager_t *logger_manager_create(logger_level_t default_log_level);
+
+
+#endif /*LOGGER_MANAGER_H_*/