GeBR Log Class

GeBR Log Class — GeBR's logging class

Synopsis

#include <libgebr/log.h>

enum                GebrLogMessageType;
GebrLog *           gebr_log_open                       (const gchar *path);
GList *             gebr_log_messages_read              (GebrLog *log);
void                gebr_log_messages_free              (GList *messages);
void                gebr_log_add_message                (GebrLog *log,
                                                         GebrLogMessageType type,
                                                         const gchar *message);
void                gebr_log_close                      (GebrLog *log);
GebrLogMessage *    gebr_log_message_new                (GebrLogMessageType type,
                                                         const gchar *date,
                                                         const gchar *message);
const gchar *       gebr_log_message_get_date           (GebrLogMessage *message);
const gchar *       gebr_log_message_get_message        (GebrLogMessage *message);
GebrLogMessageType  gebr_log_message_get_type           (GebrLogMessage *message);
void                gebr_log_message_free               (GebrLogMessage *message);
void                gebr_log_set_default                (const gchar *path);
void                gebr_log                            (GebrLogMessageType type,
                                                         const gchar *msg,
                                                         ...);
                    GebrLogMessage;
                    GebrLog;

Description

The GeBR logging class provides functions for logging various types of messages, such as informative messages and error messages.

Details

enum GebrLogMessageType

typedef enum {
	GEBR_LOG_START,
	GEBR_LOG_END,
	GEBR_LOG_INFO,
	GEBR_LOG_ERROR,
	GEBR_LOG_WARNING,
	GEBR_LOG_DEBUG,
	GEBR_LOG_MSG
} GebrLogMessageType;

gebr_log_open ()

GebrLog *           gebr_log_open                       (const gchar *path);

gebr_log_messages_read ()

GList *             gebr_log_messages_read              (GebrLog *log);

gebr_log_messages_free ()

void                gebr_log_messages_free              (GList *messages);

gebr_log_add_message ()

void                gebr_log_add_message                (GebrLog *log,
                                                         GebrLogMessageType type,
                                                         const gchar *message);

gebr_log_close ()

void                gebr_log_close                      (GebrLog *log);

gebr_log_message_new ()

GebrLogMessage *    gebr_log_message_new                (GebrLogMessageType type,
                                                         const gchar *date,
                                                         const gchar *message);

type :

The type of this message.

date :

When this message occured.

message :

The message itself.

Returns :

A newly allocated GebrLogMessage structure. Free with gebr_log_message_free().

gebr_log_message_get_date ()

const gchar *       gebr_log_message_get_date           (GebrLogMessage *message);

message :

The GebrLogMessage.

Returns :

The time in which this message was sent; do not free it.

gebr_log_message_get_message ()

const gchar *       gebr_log_message_get_message        (GebrLogMessage *message);

message :

The GebrLogMessage.

Returns :

The message that was sent; do not free it.

gebr_log_message_get_type ()

GebrLogMessageType  gebr_log_message_get_type           (GebrLogMessage *message);

message :

The GebrLogMessage.

Returns :

The type of this message.

gebr_log_message_free ()

void                gebr_log_message_free               (GebrLogMessage *message);

Free the message structure.

message :

The GebrLogMessage.

gebr_log_set_default ()

void                gebr_log_set_default                (const gchar *path);

Sets the default path for logging.


gebr_log ()

void                gebr_log                            (GebrLogMessageType type,
                                                         const gchar *msg,
                                                         ...);

Logs into the default path. See gebr_log_set_default().


GebrLogMessage

typedef struct _GebrLogMessage GebrLogMessage;

GebrLog

typedef struct _GebrLog GebrLog;