2 * @file logger_manager.h
4 * @brief Interface of logger_manager_t.
9 * Copyright (C) 2005 Jan Hutter, Martin Willi
10 * Hochschule fuer Technik Rapperswil
12 * This program is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU General Public License as published by the
14 * Free Software Foundation; either version 2 of the License, or (at your
15 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
19 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
23 #ifndef LOGGER_MANAGER_H_
24 #define LOGGER_MANAGER_H_
28 #include <utils/logger.h>
30 typedef enum logger_context_t logger_context_t
;
33 * @brief Context of a specific logger
37 enum logger_context_t
{
51 CONFIGURATION_MANAGER
,
54 typedef struct logger_manager_t logger_manager_t
;
57 * Class to manage logger_t objects.
61 struct logger_manager_t
{
64 * @brief Gets a logger_t object for a specific logger context.
66 * @warning Objects of type logger_t which are not destroyed over function
67 * #logger_manager_t.destroy_logger are destroyed in logger_managers
68 * destroy function. Don't use logger_t's own destroy function with
69 * managed logger_t objects.
71 * @param this logger_manager_t object
72 * @param context logger_context to use the logger for
73 * @param[out] logger pointer to a a place where the new logger is stored
74 * @param name name for the new logger. Context name is already included
75 * and has not to be specified (so NULL is allowed)
78 * - NULL if out of ressources
80 logger_t
*(*create_logger
) (logger_manager_t
*this, logger_context_t context
, char *name
);
84 * @brief Destroys a logger_t object which is not used anymore.
86 * @warning Objects of type logger_t which are not destroyed over function
87 * #logger_manager_t.destroy_logger are destroyed in logger_managers
90 * @param this logger_manager_t object
91 * @param logger pointer to the logger which has to be destroyed
93 * - OUT_OF_RES (when searching the specific logger_t object)
96 status_t (*destroy_logger
) (logger_manager_t
*this,logger_t
*logger
);
99 * Returns the set logger_level of a specific context or 0.
101 * @param this calling object
102 * @param context context to check level
103 * @return logger_level for the given logger_context
105 logger_level_t (*get_logger_level
) (logger_manager_t
*this, logger_context_t context
);
108 * Enables a logger_level of a specific context.
110 * @param this calling object
111 * @param context context to set level
112 * @param logger_level logger_level to eanble
117 status_t (*enable_logger_level
) (logger_manager_t
*this, logger_context_t context
,logger_level_t logger_level
);
121 * Disables a logger_level of a specific context.
123 * @param this calling object
124 * @param context context to set level
125 * @param logger_level logger_level to disable
130 status_t (*disable_logger_level
) (logger_manager_t
*this, logger_context_t context
,logger_level_t logger_level
);
134 * @brief Destroys a logger_manager_t object.
136 * All remaining managed logger_t objects are also destroyed.
138 * @param this logger_manager_t object
140 * - SUCCESS in any case
142 status_t (*destroy
) (logger_manager_t
*this);
146 * @brief Constructor to create a logger_manager_t object.
148 * @param default_log_level default log level for a context
150 * - logger_manager_t object
151 * - NULL if out of ressources
155 logger_manager_t
*logger_manager_create(logger_level_t default_log_level
);
158 #endif /*LOGGER_MANAGER_H_*/