Log4gAppenderAttachable

Log4gAppenderAttachable — Attach appenders to objects

Synopsis

                    Log4gAppenderAttachable;
struct              Log4gAppenderAttachableInterface;
void                log4g_appender_attachable_add_appender
                                                        (Log4gAppenderAttachable *self,
                                                         Log4gAppender *appender);
const GArray *      log4g_appender_attachable_get_all_appenders
                                                        (Log4gAppenderAttachable *self);
Log4gAppender *     log4g_appender_attachable_get_appender
                                                        (Log4gAppenderAttachable *self,
                                                         const gchar *name);
gboolean            log4g_appender_attachable_is_attached
                                                        (Log4gAppenderAttachable *self,
                                                         Log4gAppender *appender);
void                log4g_appender_attachable_remove_all_appenders
                                                        (Log4gAppenderAttachable *self);
void                log4g_appender_attachable_remove_appender
                                                        (Log4gAppenderAttachable *self,
                                                         Log4gAppender *appender);
void                log4g_appender_attachable_remove_appender_name
                                                        (Log4gAppenderAttachable *self,
                                                         const gchar *name);
void                (*Log4gAppenderAttachableAddAppender)
                                                        (Log4gAppenderAttachable *self,
                                                         Log4gAppender *appender);
const GArray        (*Log4gAppenderAttachableGetAllAppenders)
                                                        (Log4gAppenderAttachable *self);
Log4gAppender       (*Log4gAppenderAttachableGetAppender)
                                                        (Log4gAppenderAttachable *self,
                                                         const gchar *name);
gboolean            (*Log4gAppenderAttachableIsAttached)
                                                        (Log4gAppenderAttachable *self,
                                                         Log4gAppender *appender);
void                (*Log4gAppenderAttachableRemoveAllAppenders)
                                                        (Log4gAppenderAttachable *self);
void                (*Log4gAppenderAttachableRemoveAppender)
                                                        (Log4gAppenderAttachable *self,
                                                         Log4gAppender *appender);
void                (*Log4gAppenderAttachableRemoveAppenderName)
                                                        (Log4gAppenderAttachable *self,
                                                         const gchar *name);

Description

This interface defines a standard API for attaching appenders to other objects (e.g. loggers, other appenders).

Details

Log4gAppenderAttachable

typedef struct _Log4gAppenderAttachable Log4gAppenderAttachable;

struct Log4gAppenderAttachableInterface

struct Log4gAppenderAttachableInterface {
    Log4gAppenderAttachableAddAppender add_appender;
    Log4gAppenderAttachableGetAllAppenders get_all_appenders;
    Log4gAppenderAttachableGetAppender get_appender;
    Log4gAppenderAttachableIsAttached is_attached;
    Log4gAppenderAttachableRemoveAllAppenders remove_all_appenders;
    Log4gAppenderAttachableRemoveAppender remove_appender;
    Log4gAppenderAttachableRemoveAppenderName remove_appender_name;
};

Log4gAppenderAttachableAddAppender add_appender;

 Attach an appender to an object.

Log4gAppenderAttachableGetAllAppenders get_all_appenders;

 Get all appenders attached to an object.

Log4gAppenderAttachableGetAppender get_appender;

 Get an appender attached to an object by name.

Log4gAppenderAttachableIsAttached is_attached;

 Determine if an appender is attached to an object.

Log4gAppenderAttachableRemoveAllAppenders remove_all_appenders;

 Remove all appenders attached to an object.

Log4gAppenderAttachableRemoveAppender remove_appender;

 Remove an appender attached to an object.

Log4gAppenderAttachableRemoveAppenderName remove_appender_name;

 Remove an appender attached to an object by name.

log4g_appender_attachable_add_appender ()

void                log4g_appender_attachable_add_appender
                                                        (Log4gAppenderAttachable *self,
                                                         Log4gAppender *appender);

Call the add_appender function from the Log4gAppenderAttachableInterface of self.

self :

 An appender attachable object.

appender :

 An appender.

Since 0.1

log4g_appender_attachable_get_all_appenders ()

const GArray *      log4g_appender_attachable_get_all_appenders
                                                        (Log4gAppenderAttachable *self);

Call the get_all_appenders function from the Log4gAppenderAttachableInterface of self.

self :

 An appender attachable object.

Returns :

 An array of appenders attached to self.

Since 0.1

log4g_appender_attachable_get_appender ()

Log4gAppender *     log4g_appender_attachable_get_appender
                                                        (Log4gAppenderAttachable *self,
                                                         const gchar *name);

Call the get_appender function from the Log4gAppenderAttachableInterface of self.

self :

 An appender attachable object.

name :

 The name of the appender to retrieve.

Returns :

 The appender named name, or NULL if not found.

Since 0.1

log4g_appender_attachable_is_attached ()

gboolean            log4g_appender_attachable_is_attached
                                                        (Log4gAppenderAttachable *self,
                                                         Log4gAppender *appender);

Call the is_attached function from the Log4gAppenderAttachableInterface of self.

self :

 An appender attachable object.

appender :

 The appender to check.

Since 0.1

log4g_appender_attachable_remove_all_appenders ()

void                log4g_appender_attachable_remove_all_appenders
                                                        (Log4gAppenderAttachable *self);

Call the remove_all_appenders function from the Log4gAppenderAttachableInterface of self.

self :

 An appender attachable object.

Since 0.1

log4g_appender_attachable_remove_appender ()

void                log4g_appender_attachable_remove_appender
                                                        (Log4gAppenderAttachable *self,
                                                         Log4gAppender *appender);

Call the remove_appender function from the Log4gAppenderAttachableInterface of self.

self :

 An appender attachable object.

appender :

 The appender to remove.

Since 0.1

log4g_appender_attachable_remove_appender_name ()

void                log4g_appender_attachable_remove_appender_name
                                                        (Log4gAppenderAttachable *self,
                                                         const gchar *name);

Call the remove_appender_name function from the Log4gAppenderAttachableInterface of self.

self :

 An appender attachable object.

name :

 The name of the appender to remove.

Since 0.1

Log4gAppenderAttachableAddAppender ()

void                (*Log4gAppenderAttachableAddAppender)
                                                        (Log4gAppenderAttachable *self,
                                                         Log4gAppender *appender);

Attach an appender to an object.

self :

 An appender attachable object.

appender :

 The appender to attach.

Since 0.1

Log4gAppenderAttachableGetAllAppenders ()

const GArray        (*Log4gAppenderAttachableGetAllAppenders)
                                                        (Log4gAppenderAttachable *self);

Retrieve all previously attached appenders in an array.

Note

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

self :

 An appender attachable object.

Returns :

 A new array of appenders attached to self. If no appenders are attached, this function shall return NULL.

Since 0.1

Log4gAppenderAttachableGetAppender ()

Log4gAppender       (*Log4gAppenderAttachableGetAppender)
                                                        (Log4gAppenderAttachable *self,
                                                         const gchar *name);

Retrieve an attached appender by name.

self :

 An appender attachable object.

name :

 The name of the appneder to retrieve.

Returns :

 The appender identified by name or NULL if the named appender was not found.

Since 0.1

Log4gAppenderAttachableIsAttached ()

gboolean            (*Log4gAppenderAttachableIsAttached)
                                                        (Log4gAppenderAttachable *self,
                                                         Log4gAppender *appender);

Determine if an appender is attached to an object.

self :

 An appender attachable object.

appender :

 The appender to check.

Returns :

 TRUE if the named appender is attached to self, FALSE otherwise.

Since 0.1

Log4gAppenderAttachableRemoveAllAppenders ()

void                (*Log4gAppenderAttachableRemoveAllAppenders)
                                                        (Log4gAppenderAttachable *self);

Remove all attached appenders from an object.

self :

 An appender attachable object.

Since 0.1

Log4gAppenderAttachableRemoveAppender ()

void                (*Log4gAppenderAttachableRemoveAppender)
                                                        (Log4gAppenderAttachable *self,
                                                         Log4gAppender *appender);

Remove an attached appender from an object.

self :

 An appender attachable object.

appender :

 The appender to remove.

Since 0.1

Log4gAppenderAttachableRemoveAppenderName ()

void                (*Log4gAppenderAttachableRemoveAppenderName)
                                                        (Log4gAppenderAttachable *self,
                                                         const gchar *name);

Remove a named appender from an object.

self :

 An appender attachable object.

name :

 The name of the appedner to remove.

Since 0.1

See Also

Log4gAppenderClass
Generated by GTK-Doc V1.15