Log4gLoggerRepository

Log4gLoggerRepository — Create and retrieve loggers

Synopsis

                    Log4gLoggerRepository;
                    Log4gLoggerRepositoryInterface;
Log4gLogger *       log4g_logger_repository_exists      (Log4gLoggerRepository *self,
                                                         const gchar *name);
void                log4g_logger_repository_emit_add_appender_signal
                                                        (Log4gLoggerRepository *self,
                                                         Log4gLogger *logger,
                                                         Log4gAppender *appender);
void                log4g_logger_repository_emit_remove_appender_signal
                                                        (Log4gLoggerRepository *self,
                                                         Log4gLogger *logger,
                                                         Log4gAppender *appender);
const GArray *      log4g_logger_repository_get_current_loggers
                                                        (Log4gLoggerRepository *self);
Log4gLogger *       log4g_logger_repository_get_logger  (Log4gLoggerRepository *self,
                                                         const gchar *name);
Log4gLogger *       log4g_logger_repository_get_logger_factory
                                                        (Log4gLoggerRepository *self,
                                                         const gchar *name,
                                                         Log4gLoggerFactory *factory);
Log4gLogger *       log4g_logger_repository_get_root_logger
                                                        (Log4gLoggerRepository *self);
Log4gLevel *        log4g_logger_repository_get_threshold
                                                        (Log4gLoggerRepository *self);
gboolean            log4g_logger_repository_is_disabled (Log4gLoggerRepository *self,
                                                         gint level);
void                log4g_logger_repository_reset_configuration
                                                        (Log4gLoggerRepository *self);
void                log4g_logger_repository_set_threshold
                                                        (Log4gLoggerRepository *self,
                                                         Log4gLevel *level);
void                log4g_logger_repository_set_threshold_string
                                                        (Log4gLoggerRepository *self,
                                                         const gchar *string);
void                log4g_logger_repository_shutdown    (Log4gLoggerRepository *self);
void                log4g_logger_repository_emit_no_appender_warning
                                                        (Log4gLoggerRepository *self,
                                                         Log4gLogger *logger);
Log4gLogger         (*Log4gLoggerRepositoryExists)      (Log4gLoggerRepository *self,
                                                         const gchar *name);
const GArray        (*Log4gLoggerRepositoryGetCurrentLoggers)
                                                        (Log4gLoggerRepository *self);
Log4gLogger         (*Log4gLoggerRepositoryGetLogger)   (Log4gLoggerRepository *self,
                                                         const gchar *name);
Log4gLogger         (*Log4gLoggerRepositoryGetLoggerFactory)
                                                        (Log4gLoggerRepository *self,
                                                         const gchar *name,
                                                         Log4gLoggerFactory *factory);
Log4gLogger         (*Log4gLoggerRepositoryGetRootLogger)
                                                        (Log4gLoggerRepository *self);
Log4gLevel          (*Log4gLoggerRepositoryGetThreshold)
                                                        (Log4gLoggerRepository *self);
gboolean            (*Log4gLoggerRepositoryIsDisabled)  (Log4gLoggerRepository *self,
                                                         gint level);
void                (*Log4gLoggerRepositoryResetConfiguration)
                                                        (Log4gLoggerRepository *self);
void                (*Log4gLoggerRepositorySetThreshold)
                                                        (Log4gLoggerRepository *self,
                                                         Log4gLevel *level);
void                (*Log4gLoggerRepositorySetThresholdString)
                                                        (Log4gLoggerRepository *self,
                                                         const gchar *level);
void                (*Log4gLoggerRepositoryShutdown)    (Log4gLoggerRepository *self);
void                (*Log4gLoggerRepositoryEmitNoAppenderWarning)
                                                        (Log4gLoggerRepository *self,
                                                         Log4gLogger *logger);

Description

A logger repository is used to create and retrieve loggers. The relationship between loggers and the repository depends on the repository implementation but usually loggers are arranged in a named hierarchy.

In addition to the create functions, a logger repository can be queried for existing loggers and act as a registry for events related to loggers.

Logger repositories have the following signals:

  • add-appender

  • remove-appender

The add-appender signal is invoked whenever an appender is added to a logger in the repository.

The type signature for the add-appender signal is: 

typedef void
(*add_appender)(Log4gLogger *logger, Log4gAppender *appender);

The remove-appender signal is invoked whenever an appender is removed from a logger in the repository.

The type signature for the remove-appender signal is: 

typedef void
(*remove_appender)(Log4gLogger *logger, Log4gAppender *appender);

Details

Log4gLoggerRepository

typedef struct _Log4gLoggerRepository Log4gLoggerRepository;

Log4gLoggerRepositoryInterface

typedef struct {
    Log4gLoggerRepositoryExists exists;
    Log4gLoggerRepositoryGetCurrentLoggers get_current_loggers;
    Log4gLoggerRepositoryGetLogger get_logger;
    Log4gLoggerRepositoryGetLoggerFactory get_logger_factory;
    Log4gLoggerRepositoryGetRootLogger get_root_logger;
    Log4gLoggerRepositoryGetThreshold get_threshold;
    Log4gLoggerRepositoryIsDisabled is_disabled;
    Log4gLoggerRepositoryResetConfiguration reset_configuration;
    Log4gLoggerRepositorySetThreshold set_threshold;
    Log4gLoggerRepositorySetThresholdString set_threshold_string;
    Log4gLoggerRepositoryShutdown shutdown;
    Log4gLoggerRepositoryEmitNoAppenderWarning emit_no_appender_warning;
} Log4gLoggerRepositoryInterface;

Log4gLoggerRepositoryExists exists;

 Determine if a given logger exists in the repository.

Log4gLoggerRepositoryGetCurrentLoggers get_current_loggers;

 Get all loggers in the repository.

Log4gLoggerRepositoryGetLogger get_logger;

 Get an existing logger or create a new one.

Log4gLoggerRepositoryGetLoggerFactory get_logger_factory;

 Get an existing logger or create it with a factory.

Log4gLoggerRepositoryGetRootLogger get_root_logger;

 Get the root logger.

Log4gLoggerRepositoryGetThreshold get_threshold;

 Get the repository threshold.

Log4gLoggerRepositoryIsDisabled is_disabled;

 Determine if the repository is disabled at a given level.

Log4gLoggerRepositoryResetConfiguration reset_configuration;

 Reset the repository configuration.

Log4gLoggerRepositorySetThreshold set_threshold;

 Set the repository threshold.

Log4gLoggerRepositorySetThresholdString set_threshold_string;

 Set the repository threshold by string value.

Log4gLoggerRepositoryShutdown shutdown;

 Shut down the logger repository.

Log4gLoggerRepositoryEmitNoAppenderWarning emit_no_appender_warning;

 Emit a warning if no appenders are attached.

log4g_logger_repository_exists ()

Log4gLogger *       log4g_logger_repository_exists      (Log4gLoggerRepository *self,
                                                         const gchar *name);

Call the exists function from the Log4gLoggerRepositoryInterface of self.

self :

 A logger repository object.

name :

 The name of the logger to check.

Returns :

 The logger named name or NULL if it does not exist.

Since 0.1

log4g_logger_repository_emit_add_appender_signal ()

void                log4g_logger_repository_emit_add_appender_signal
                                                        (Log4gLoggerRepository *self,
                                                         Log4gLogger *logger,
                                                         Log4gAppender *appender);

Emit the the add-appender signal of self.

self :

 A logger repository object.

logger :

 The logger from to appender was added.

appender :

 The appender that was added.

Since 0.1

log4g_logger_repository_emit_remove_appender_signal ()

void                log4g_logger_repository_emit_remove_appender_signal
                                                        (Log4gLoggerRepository *self,
                                                         Log4gLogger *logger,
                                                         Log4gAppender *appender);

Emit the remove-appender signal of self.

self :

 A logger repository object.

logger :

 The logger from which appender was removed.

appender :

 The appender that was removed.

Since 0.1

log4g_logger_repository_get_current_loggers ()

const GArray *      log4g_logger_repository_get_current_loggers
                                                        (Log4gLoggerRepository *self);

Call the get_current_loggers function from the Log4gLoggerRepositoryInterface of self.

self :

 A logger repository object.

Returns :

 An array containing all loggers in the repository or NULL if there are none.

Since 0.1

log4g_logger_repository_get_logger ()

Log4gLogger *       log4g_logger_repository_get_logger  (Log4gLoggerRepository *self,
                                                         const gchar *name);

Call the get_logger function from the Log4gLoggerRepositoryInterface of self.

self :

 A logger repository object.

name :

 The name of the logger to retrieve.

Returns :

 The logger named name.

Since 0.1

log4g_logger_repository_get_logger_factory ()

Log4gLogger *       log4g_logger_repository_get_logger_factory
                                                        (Log4gLoggerRepository *self,
                                                         const gchar *name,
                                                         Log4gLoggerFactory *factory);

Call the get_logger_factory function from the Log4gLoggerRepositoryInterface of self.

self :

 A logger repository object.

name :

 The name of the logger to retrieve.

factory :

 The factory to use.

Returns :

 The logger named name.

Since 0.1

log4g_logger_repository_get_root_logger ()

Log4gLogger *       log4g_logger_repository_get_root_logger
                                                        (Log4gLoggerRepository *self);

Call the get_root_logger function from the Log4gLoggerRepositoryInterface of self.

self :

 A logger repository object.

Returns :

 The root logger.

Since 0.1

log4g_logger_repository_get_threshold ()

Log4gLevel *        log4g_logger_repository_get_threshold
                                                        (Log4gLoggerRepository *self);

Call the get_threshold function from the Log4gLoggerRepositoryInterface of self.

See: Log4gLevelClass

self :

 A logger repository object.

Returns :

 The threshold level for self.

Since 0.1

log4g_logger_repository_is_disabled ()

gboolean            log4g_logger_repository_is_disabled (Log4gLoggerRepository *self,
                                                         gint level);

Call the is_disabled function from the Log4gLoggerRepositoryInterface of self.

See: Log4gLevelClass

self :

 A logger repository object.

level :

 The integer representation of a log level.

Returns :

 TRUE if self is disabled for level, FALSE otherwise.

Since 0.1

log4g_logger_repository_reset_configuration ()

void                log4g_logger_repository_reset_configuration
                                                        (Log4gLoggerRepository *self);

Call the reset_configuration function from the Log4gLoggerRepositoryInterface of self.

self :

 A logger repository object.

Since 0.1

log4g_logger_repository_set_threshold ()

void                log4g_logger_repository_set_threshold
                                                        (Log4gLoggerRepository *self,
                                                         Log4gLevel *level);

Call the set_threshold function from the Log4gLoggerRepositoryInterface of self.

See: Log4gLevelClass

self :

 A logger repository object.

level :

 The new threshold for self.

Since 0.1

log4g_logger_repository_set_threshold_string ()

void                log4g_logger_repository_set_threshold_string
                                                        (Log4gLoggerRepository *self,
                                                         const gchar *string);

Call the set_threshold_string function from the Log4gLoggerRepositoryInterface of self.

self :

 A logger repository object.

string :

 The name of the new threshold to set.

Since 0.1

log4g_logger_repository_shutdown ()

void                log4g_logger_repository_shutdown    (Log4gLoggerRepository *self);

Call the shutdown function from the Log4gLoggerRepositoryInterface of self.

self :

 A logger repository object.

Since 0.1

log4g_logger_repository_emit_no_appender_warning ()

void                log4g_logger_repository_emit_no_appender_warning
                                                        (Log4gLoggerRepository *self,
                                                         Log4gLogger *logger);

Call the emit_no_appender_warning function from the Log4gLoggerRepositoryInterface of self.

self :

 A logger repository object.

logger :

 The logger that produced the warning.

Since 0.1

Log4gLoggerRepositoryExists ()

Log4gLogger         (*Log4gLoggerRepositoryExists)      (Log4gLoggerRepository *self,
                                                         const gchar *name);

Determine if a named logger exists.

If the named logger does not exist it is not created.

self :

 A logger repository object.

name :

 The name of the logger to check.

Returns :

 The logger named name or NULL if it does not exist.

Since 0.1

Log4gLoggerRepositoryGetCurrentLoggers ()

const GArray        (*Log4gLoggerRepositoryGetCurrentLoggers)
                                                        (Log4gLoggerRepository *self);

Retrieve all loggers in the repository.

Note

It is the responsibility of the caller to call g_array_free() for the returned value.

self :

 A logger repository object.

Returns :

 An array containing all loggers in the repository or NULL if there are none.

Since 0.1

Log4gLoggerRepositoryGetLogger ()

Log4gLogger         (*Log4gLoggerRepositoryGetLogger)   (Log4gLoggerRepository *self,
                                                         const gchar *name);

Retrieve a named logger from the repository.

If the logger named name does not already exist it should be created and added to the repository.

self :

 A logger repository object.

name :

 The name of the logger to retrieve.

Returns :

 The logger named name.

Since 0.1

Log4gLoggerRepositoryGetLoggerFactory ()

Log4gLogger         (*Log4gLoggerRepositoryGetLoggerFactory)
                                                        (Log4gLoggerRepository *self,
                                                         const gchar *name,
                                                         Log4gLoggerFactory *factory);

Retrieve a named logger from the repository.

If the logger named name does not already exist it should be created using factory and added to the repository.

self :

 A logger repository object.

name :

 The name of the logger to retrieve.

factory :

 The factory to use.

Returns :

 The logger named name.

Since 0.1

Log4gLoggerRepositoryGetRootLogger ()

Log4gLogger         (*Log4gLoggerRepositoryGetRootLogger)
                                                        (Log4gLoggerRepository *self);

Retrieve the root logger.

self :

 A logger repository object.

Returns :

 The root logger.

Since 0.1

Log4gLoggerRepositoryGetThreshold ()

Log4gLevel          (*Log4gLoggerRepositoryGetThreshold)
                                                        (Log4gLoggerRepository *self);

Retrieve the repository threshold.

See: Log4gLevelClass, Log4gLoggerRepositoryInterface.set_threshold

self :

 A logger repository object.

Returns :

 The threshold level for self.

Since 0.1

Log4gLoggerRepositoryIsDisabled ()

gboolean            (*Log4gLoggerRepositoryIsDisabled)  (Log4gLoggerRepository *self,
                                                         gint level);

Determine if the repository is disabled for a given log level.

\see Log4gLevelClass, Log4gLoggerRepositoryInterface.set_threshold

self :

 A logger repository object.

level :

 The integer representation of a log level.

Returns :

 TRUE if self is disabled for level, FALSE otherwise.

Since 0.1

Log4gLoggerRepositoryResetConfiguration ()

void                (*Log4gLoggerRepositoryResetConfiguration)
                                                        (Log4gLoggerRepository *self);

Reset a repository to its initial state.

self :

 A logger repository object.

Since 0.1

Log4gLoggerRepositorySetThreshold ()

void                (*Log4gLoggerRepositorySetThreshold)
                                                        (Log4gLoggerRepository *self,
                                                         Log4gLevel *level);

Set the repository threshold.

All logging requests below the threshold are immediately dropped. By default the threshold is set to ALL, which has the lowest possible rank.

See: Log4gLevelClass

self :

 A logger repository object.

level :

 The new threshold for self.

Since 0.1

Log4gLoggerRepositorySetThresholdString ()

void                (*Log4gLoggerRepositorySetThresholdString)
                                                        (Log4gLoggerRepository *self,
                                                         const gchar *level);

Set the repository threshold from a string.

See: Log4gLevelClass

self :

 A logger repository object.

level :

 The new threshold level name to set.

Since 0.1

Log4gLoggerRepositoryShutdown ()

void                (*Log4gLoggerRepositoryShutdown)    (Log4gLoggerRepository *self);

Shutdown the repository.

Once the repository is shut down it cannot be used by the Log4g system.

self :

 A logger repository object.

Since 0.1

Log4gLoggerRepositoryEmitNoAppenderWarning ()

void                (*Log4gLoggerRepositoryEmitNoAppenderWarning)
                                                        (Log4gLoggerRepository *self,
                                                         Log4gLogger *logger);

See Also

Log4gLoggerClass
Generated by GTK-Doc V1.15