GeBR Log Class

GeBR Log Class — GeBR's logging class

Functions

GebrLog * gebr_log_open ()
GList * gebr_log_messages_read ()
void gebr_log_messages_free ()
void gebr_log_add_message ()
void gebr_log_close ()
GebrLogMessage * gebr_log_message_new ()
const gchar * gebr_log_message_get_date ()
const gchar * gebr_log_message_get_message ()
void gebr_log_message_free ()
void gebr_log_set_default ()
void gebr_log ()

Types and Values

Includes

#include <libgebr/log.h>

Description

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

Functions

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);

Parameters

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);

Parameters

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);

Parameters

message

The GebrLogMessage.

 

Returns

The message that was sent; do not free it.


gebr_log_message_free ()

void
gebr_log_message_free (GebrLogMessage *message);

Free the message structure.

Parameters

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().

Types and Values

enum GebrLogMessageType

Members

GEBR_LOG_START

   

GEBR_LOG_END

   

GEBR_LOG_INFO

   

GEBR_LOG_ERROR

   

GEBR_LOG_WARNING

   

GEBR_LOG_DEBUG

   

GEBR_LOG_MSG

   

GebrLog

typedef struct _GebrLog GebrLog;