gkrellm/shared/log-private.h

86 lines
2.7 KiB
C
Raw Normal View History

/* GKrellM
| Copyright (C) 1999-2010 Bill Wilson
|
| Author: Stefan Gehn stefan+gkrellm@srcbox.net
| Latest versions might be found at: http://gkrellm.net
|
|
| GKrellM 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 3 of the License, or
| (at your option) any later version.
|
| GKrellM 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/
|
|
| Additional permission under GNU GPL version 3 section 7
|
| If you modify this program, or any covered work, by linking or
| combining it with the OpenSSL project's OpenSSL library (or a
| modified version of that library), containing parts covered by
| the terms of the OpenSSL or SSLeay licenses, you are granted
| additional permission to convey the resulting work.
| Corresponding Source for a non-source form of such a combination
| shall include the source code for the parts of OpenSSL used as well
| as that of the covered work.
*/
#ifndef GK_LOG_P_H
#define GK_LOG_P_H
#include <glib.h>
typedef void (*GkrellmLogFunc) (GLogLevelFlags log_level, const gchar *message);
typedef gboolean (*GkrellmLogInitFunc) (void);
typedef gboolean (*GkrellmLogCleanupFunc) (void);
/**
* Installs a log handler and adds default logging behaviour.
*
* All GLib log functions and macros (i..e g_log(), g_debug(), g_warning() etc)
* are handled by our log handler from now on
**/
void gkrellm_log_init(void);
/**
* Removes our log handler reverting to default GLib log behaviour.
**/
void gkrellm_log_cleanup(void);
/**
* Registers another log function.
*
* Calls function @p init if it's not NULL and registers function @p log if
* the (optional) call to @p init was successful.
*
* @note This is mainly used by gkrellmd to register an additional
* syslog handler.
**/
gboolean gkrellm_log_register(
GkrellmLogFunc log,
GkrellmLogInitFunc init,
GkrellmLogCleanupFunc cleanup);
/**
* Unregisters a log function
*
* Also calls the GkrellmLogCleanupFunc passed together with @p log
* in gkrellm_log_register().
**/
gboolean gkrellm_log_unregister(GkrellmLogFunc log);
/**
* Enables or disables logging into a file
*
* @param filename path to logfile or NULL to disable logging into a file
**/
void gkrellm_log_set_filename(const gchar* filename);
#endif //GK_LOG_P_H