Log4gAppender

typedef struct {
} Log4gAppender;

The Log4gAppender structure does not have any public members.

Log4gAppenderClass

typedef struct {
    Log4gAppenderAddFilter add_filter;
    Log4gAppenderGetFilter get_filter;
    Log4gAppenderClose close;
    Log4gAppenderAppend append;
    Log4gAppenderDoAppend do_append;
    Log4gAppenderSetName set_name;
    Log4gAppenderGetName get_name;
    Log4gAppenderSetErrorHandler set_error_handler;
    Log4gAppenderGetErrorHandler get_error_handler;
    Log4gAppenderSetLayout set_layout;
    Log4gAppenderGetLayout get_layout;
    Log4gAppenderRequiresLayout requires_layout;
    Log4gAppenderActivateOptions activate_options;
} Log4gAppenderClass;

log4g_appender_clear_filters ()

void                log4g_appender_clear_filters        (Log4gAppender *self);

Remove all filters attached to this appender.

Since 0.1

log4g_appender_add_filter ()

void                log4g_appender_add_filter           (Log4gAppender *self,
                                                         Log4gFilter *filter);

Calls the add_filter function from the Log4gAppenderClass of self.

Since 0.1

log4g_appender_get_filter ()

Log4gFilter *       log4g_appender_get_filter           (Log4gAppender *self);

Calls the get_filter function from the Log4gAppenderClass of self.

Since 0.1

log4g_appender_close ()

void                log4g_appender_close                (Log4gAppender *self);

Calls the close function from the Log4gAppenderClass of self.

Since 0.1

log4g_appender_do_append ()

void                log4g_appender_do_append            (Log4gAppender *self,
                                                         Log4gLoggingEvent *event);

Calls the do_append function from the Log4gAppenderClass of self.

Since 0.1

log4g_appender_get_name ()

const gchar *       log4g_appender_get_name             (Log4gAppender *self);

Calls the get_name function from the Log4gAppenderClass of self.

Since 0.1

log4g_appender_set_error_handler ()

void                log4g_appender_set_error_handler    (Log4gAppender *self,
                                                         gpointer handler);

Calls the set_error_handler function from the Log4gAppenderClass of self.

Since 0.1

log4g_appender_get_error_handler ()

gpointer            log4g_appender_get_error_handler    (Log4gAppender *self);

Calls the get_error_handler function from the Log4gAppenderClass of self.

Since 0.1

log4g_appender_set_layout ()

void                log4g_appender_set_layout           (Log4gAppender *self,
                                                         Log4gLayout *layout);

Calls the set_layout function from the Log4gAppenderClass of self.

Since 0.1

log4g_appender_get_layout ()

Log4gLayout *       log4g_appender_get_layout           (Log4gAppender *self);

Calls the get_layout function from the Log4gAppenderClass of self.

Since 0.1

log4g_appender_set_name ()

void                log4g_appender_set_name             (Log4gAppender *self,
                                                         const gchar *name);

Calls the set_name function from the Log4gAppenderClass of self.

Since 0.1

log4g_appender_requires_layout ()

gboolean            log4g_appender_requires_layout      (Log4gAppender *self);

Calls the requires_layout function from the Log4gAppenderClass of self.

Since 0.1

log4g_appender_activate_options ()

void                log4g_appender_activate_options     (Log4gAppender *self);

Calls the activate_options function from the Log4gAppenderClass of self.

Since 0.1

log4g_appender_append ()

void                log4g_appender_append               (Log4gAppender *self,
                                                         Log4gLoggingEvent *event);

Calls the append function from the Log4gAppenderClass of self.

Since 0.1

log4g_appender_get_first_filter ()

Log4gFilter *       log4g_appender_get_first_filter     (Log4gAppender *self);

Retrieve the first filter in the filter chain.

Since 0.1

log4g_appender_is_as_severe_as ()

gboolean            log4g_appender_is_as_severe_as      (Log4gAppender *self,
                                                         Log4gLevel *level);

Determine if a log level is below the appender's threshold.

If there is no threshold set then the return value is always TRUE.

Since 0.1

log4g_appender_set_threshold ()

void                log4g_appender_set_threshold        (Log4gAppender *self,
                                                         const gchar *threshold);

Set the threshold property for this appender.

Since 0.1

log4g_appender_get_threshold ()

Log4gLevel *        log4g_appender_get_threshold        (Log4gAppender *self);

Retrieve the threshold property.

Since 0.1

log4g_appender_get_closed ()

gboolean            log4g_appender_get_closed           (Log4gAppender *self);

Determine if an appender has been closed.

Since 0.1

log4g_appender_set_closed ()

void                log4g_appender_set_closed           (Log4gAppender *self,
                                                         gboolean closed);

Set the closed parameter.

Appenders should set this value appropriately. The default value is FALSE.

Since 0.1

Log4gAppenderAddFilter ()

void                (*Log4gAppenderAddFilter)           (Log4gAppender *self,
                                                         Log4gFilter *filter);

Add a filter to the end of the filter chain.

See: Log4gFilter

Since 0.1

Log4gAppenderGetFilter ()

Log4gFilter         (*Log4gAppenderGetFilter)           (Log4gAppender *self);

Filters are organized in a linked list so all filters are available through the result of this function.

See: Log4gFilter

Since 0.1

Log4gAppenderClose ()

void                (*Log4gAppenderClose)               (Log4gAppender *self);

Release any resources allocated within the appender such as file handles, network connections, etc. A closed appender is no longer usable by the Log4g system.

Since 0.1

Log4gAppenderAppend ()

void                (*Log4gAppenderAppend)              (Log4gAppender *base,
                                                         Log4gLoggingEvent *event);

Sub-classes should implement this abstract virtual function to perform actual logging.

See: Log4gLoggingEvent

Since 0.1

Log4gAppenderDoAppend ()

void                (*Log4gAppenderDoAppend)            (Log4gAppender *self,
                                                         Log4gLoggingEvent *event);

Loggers will call this function in order to log events.

See: Log4gLoggingEvent

Since 0.1

Log4gAppenderSetName ()

void                (*Log4gAppenderSetName)             (Log4gAppender *self,
                                                         const gchar *name);

The name may be used by other components to uniquely identify the appender.

Since 0.1

Log4gAppenderGetName ()

const gchar         (*Log4gAppenderGetName)             (Log4gAppender *self);

The name uniquely identifies this appender.

Since 0.1

Log4gAppenderSetErrorHandler ()

void                (*Log4gAppenderSetErrorHandler)     (Log4gAppender *self,
                                                         gpointer handler);

Set the error handler for this appender.

See: Log4gErrorHandler

Since 0.1

Log4gAppenderGetErrorHandler ()

gpointer            (*Log4gAppenderGetErrorHandler)     (Log4gAppender *self);

Retrieve the error handler for an appender.

See: Log4gErrorHandler

Since 0.1

Log4gAppenderSetLayout ()

void                (*Log4gAppenderSetLayout)           (Log4gAppender *self,
                                                         Log4gLayout *layout);

Set the layout for this appender.

See: Log4gLayout

Since 0.1

Log4gAppenderGetLayout ()

Log4gLayout         (*Log4gAppenderGetLayout)           (Log4gAppender *self);

Retrieve the layout for this appender.

See: Log4gLayout

Since 0.1

Log4gAppenderRequiresLayout ()

gboolean            (*Log4gAppenderRequiresLayout)      (Log4gAppender *self);

Configurators may call this method to determine if an appender requires a layout.

In the exceptional case where an appender accepts a layout but can also work without it the appender should return TRUE.

See: Log4gAppenderSetLayout, Log4gAppenderGetLayout, Log4gLayout

Since 0.1

Log4gAppenderActivateOptions ()

void                (*Log4gAppenderActivateOptions)     (Log4gAppender *self);

Activate all options set for this appender.

Since 0.1