MilterManagerConfiguration
3
milter managerライブラリ

# MilterManagerConfiguration

## 概要

    #define             MILTER_MANAGER_CONFIGURATION_ERROR
    #define             MILTER_MANAGER_CONFIGURATION        (obj)
    enum                MilterManagerConfigurationError;
                        MilterManagerConfiguration;
    GQuark              milter_manager_configuration_error_quark
                                                            (void);
    MilterManagerConfiguration * milter_manager_configuration_new
                                                            (const gchar *first_property,
                                                             ...);
    void                milter_manager_configuration_append_load_path
                                                            (MilterManagerConfiguration *configuration,
                                                             const gchar *path);
    void                milter_manager_configuration_prepend_load_path
                                                            (MilterManagerConfiguration *configuration,
                                                             const gchar *path);
    void                milter_manager_configuration_clear_load_paths
                                                            (MilterManagerConfiguration *configuration);
    const GList *       milter_manager_configuration_get_load_paths
                                                            (MilterManagerConfiguration *configuration);
    gboolean            milter_manager_configuration_load   (MilterManagerConfiguration *configuration,
                                                             const gchar *file_name,
                                                             GError **error);
    gboolean            milter_manager_configuration_load_if_exist
                                                            (MilterManagerConfiguration *configuration,
                                                             const gchar *file_name,
                                                             GError **error);
    gboolean            milter_manager_configuration_load_custom
                                                            (MilterManagerConfiguration *configuration,
                                                             const gchar *file_name,
                                                             GError **error);
    gboolean            milter_manager_configuration_load_custom_if_exist
                                                            (MilterManagerConfiguration *configuration,
                                                             const gchar *file_name,
                                                             GError **error);
    gboolean            milter_manager_configuration_reload (MilterManagerConfiguration *configuration,
                                                             GError **error);
    gboolean            milter_manager_configuration_save_custom
                                                            (MilterManagerConfiguration *configuration,
                                                             const gchar *content,
                                                             gssize size,
                                                             GError **error);
    gboolean            milter_manager_configuration_is_privilege_mode
                                                            (MilterManagerConfiguration *configuration);
    void                milter_manager_configuration_set_privilege_mode
                                                            (MilterManagerConfiguration *configuration,
                                                             gboolean mode);
    const gchar *       milter_manager_configuration_get_controller_connection_spec
                                                            (MilterManagerConfiguration *configuration);
    void                milter_manager_configuration_set_controller_connection_spec
                                                            (MilterManagerConfiguration *configuration,
                                                             const gchar *spec);
    const gchar *       milter_manager_configuration_get_manager_connection_spec
                                                            (MilterManagerConfiguration *configuration);
    void                milter_manager_configuration_set_manager_connection_spec
                                                            (MilterManagerConfiguration *configuration,
                                                             const gchar *spec);
    const gchar *       milter_manager_configuration_get_effective_user
                                                            (MilterManagerConfiguration *configuration);
    void                milter_manager_configuration_set_effective_user
                                                            (MilterManagerConfiguration *configuration,
                                                             const gchar *user_name);
    const gchar *       milter_manager_configuration_get_effective_group
                                                            (MilterManagerConfiguration *configuration);
    void                milter_manager_configuration_set_effective_group
                                                            (MilterManagerConfiguration *configuration,
                                                             const gchar *group_name);
    guint               milter_manager_configuration_get_manager_unix_socket_mode
                                                            (MilterManagerConfiguration *configuration);
    void                milter_manager_configuration_set_manager_unix_socket_mode
                                                            (MilterManagerConfiguration *configuration,
                                                             guint mode);
    guint               milter_manager_configuration_get_controller_unix_socket_mode
                                                            (MilterManagerConfiguration *configuration);
    void                milter_manager_configuration_set_controller_unix_socket_mode
                                                            (MilterManagerConfiguration *configuration,
                                                             guint mode);
    const gchar *       milter_manager_configuration_get_manager_unix_socket_group
                                                            (MilterManagerConfiguration *configuration);
    void                milter_manager_configuration_set_manager_unix_socket_group
                                                            (MilterManagerConfiguration *configuration,
                                                             const gchar *group);
    gboolean            milter_manager_configuration_is_remove_manager_unix_socket_on_close
                                                            (MilterManagerConfiguration *configuration);
    void                milter_manager_configuration_set_remove_manager_unix_socket_on_close
                                                            (MilterManagerConfiguration *configuration,
                                                             gboolean remove);
    gboolean            milter_manager_configuration_is_remove_controller_unix_socket_on_close
                                                            (MilterManagerConfiguration *configuration);
    void                milter_manager_configuration_set_remove_controller_unix_socket_on_close
                                                            (MilterManagerConfiguration *configuration,
                                                             gboolean remove);
    gboolean            milter_manager_configuration_is_remove_manager_unix_socket_on_create
                                                            (MilterManagerConfiguration *configuration);
    void                milter_manager_configuration_set_remove_manager_unix_socket_on_create
                                                            (MilterManagerConfiguration *configuration,
                                                             gboolean remove);
    gboolean            milter_manager_configuration_is_remove_controller_unix_socket_on_create
                                                            (MilterManagerConfiguration *configuration);
    void                milter_manager_configuration_set_remove_controller_unix_socket_on_create
                                                            (MilterManagerConfiguration *configuration,
                                                             gboolean remove);
    gboolean            milter_manager_configuration_is_daemon
                                                            (MilterManagerConfiguration *configuration);
    void                milter_manager_configuration_set_daemon
                                                            (MilterManagerConfiguration *configuration,
                                                             gboolean daemon);
    const gchar *       milter_manager_configuration_get_pid_file
                                                            (MilterManagerConfiguration *configuration);
    void                milter_manager_configuration_set_pid_file
                                                            (MilterManagerConfiguration *configuration,
                                                             const gchar *pid_file);
    MilterStatus        milter_manager_configuration_get_fallback_status
                                                            (MilterManagerConfiguration *configuration);
    void                milter_manager_configuration_set_fallback_status
                                                            (MilterManagerConfiguration *configuration,
                                                             MilterStatus status);
    const gchar *       milter_manager_configuration_get_package_platform
                                                            (MilterManagerConfiguration *configuration);
    void                milter_manager_configuration_set_package_platform
                                                            (MilterManagerConfiguration *configuration,
                                                             const gchar *platform);
    const gchar *       milter_manager_configuration_get_package_options
                                                            (MilterManagerConfiguration *configuration);
    void                milter_manager_configuration_set_package_options
                                                            (MilterManagerConfiguration *configuration,
                                                             const gchar *options);
    void                milter_manager_configuration_add_egg
                                                            (MilterManagerConfiguration *configuration,
                                                             MilterManagerEgg *egg);
    MilterManagerEgg *  milter_manager_configuration_find_egg
                                                            (MilterManagerConfiguration *configuration,
                                                             const gchar *name);
    const GList *       milter_manager_configuration_get_eggs
                                                            (MilterManagerConfiguration *configuration);
    void                milter_manager_configuration_remove_egg
                                                            (MilterManagerConfiguration *configuration,
                                                             MilterManagerEgg *egg);
    void                milter_manager_configuration_remove_egg_by_name
                                                            (MilterManagerConfiguration *configuration,
                                                             const gchar *name);
    void                milter_manager_configuration_clear_eggs
                                                            (MilterManagerConfiguration *configuration);
    void                milter_manager_configuration_add_applicable_condition
                                                            (MilterManagerConfiguration *configuration,
                                                             MilterManagerApplicableCondition *condition);
    MilterManagerApplicableCondition * milter_manager_configuration_find_applicable_condition
                                                            (MilterManagerConfiguration *configuration,
                                                             const gchar *name);
    const GList *       milter_manager_configuration_get_applicable_conditions
                                                            (MilterManagerConfiguration *configuration);
    void                milter_manager_configuration_remove_applicable_condition
                                                            (MilterManagerConfiguration *configuration,
                                                             MilterManagerApplicableCondition *condition);
    void                milter_manager_configuration_remove_applicable_condition_by_name
                                                            (MilterManagerConfiguration *configuration,
                                                             const gchar *name);
    void                milter_manager_configuration_clear_applicable_conditions
                                                            (MilterManagerConfiguration *configuration);
    gboolean            milter_manager_configuration_clear  (MilterManagerConfiguration *configuration,
                                                             GError **error);
    gchar *             milter_manager_configuration_to_xml (MilterManagerConfiguration *configuration);
    void                milter_manager_configuration_to_xml_string
                                                            (MilterManagerConfiguration *configuration,
                                                             GString *string,
                                                             guint indent);
    gchar *             milter_manager_configuration_dump   (MilterManagerConfiguration *configuration);

## 説明

## 詳細

### MILTER_MANAGER_CONFIGURATION_ERROR

    #define MILTER_MANAGER_CONFIGURATION_ERROR           (milter_manager_configuration_error_quark())

### MILTER_MANAGER_CONFIGURATION()

    #define MILTER_MANAGER_CONFIGURATION(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj), MILTER_TYPE_MANAGER_CONFIGURATION, MilterManagerConfiguration))

### enum MilterManagerConfigurationError

    typedef enum {
        MILTER_MANAGER_CONFIGURATION_ERROR_NOT_IMPLEMENTED,
        MILTER_MANAGER_CONFIGURATION_ERROR_NOT_EXIST,
        MILTER_MANAGER_CONFIGURATION_ERROR_UNKNOWN,
        MILTER_MANAGER_CONFIGURATION_ERROR_SAVE
    } MilterManagerConfigurationError;

### MilterManagerConfiguration

    typedef struct {
        GObject object;
    } MilterManagerConfiguration;

### milter_manager_configuration_error_quark ()

    GQuark              milter_manager_configuration_error_quark
                                                            (void);

### milter_manager_configuration_new ()

    MilterManagerConfiguration * milter_manager_configuration_new
                                                            (const gchar *first_property,
                                                             ...);

### milter_manager_configuration_append_load_path ()

    void                milter_manager_configuration_append_load_path
                                                            (MilterManagerConfiguration *configuration,
                                                             const gchar *path);

### milter_manager_configuration_prepend_load_path ()

    void                milter_manager_configuration_prepend_load_path
                                                            (MilterManagerConfiguration *configuration,
                                                             const gchar *path);

### milter_manager_configuration_clear_load_paths ()

    void                milter_manager_configuration_clear_load_paths
                                                            (MilterManagerConfiguration *configuration);

### milter_manager_configuration_get_load_paths ()

    const GList *       milter_manager_configuration_get_load_paths
                                                            (MilterManagerConfiguration *configuration);

### milter_manager_configuration_load ()

    gboolean            milter_manager_configuration_load   (MilterManagerConfiguration *configuration,
                                                             const gchar *file_name,
                                                             GError **error);

### milter_manager_configuration_load_if_exist ()

    gboolean            milter_manager_configuration_load_if_exist
                                                            (MilterManagerConfiguration *configuration,
                                                             const gchar *file_name,
                                                             GError **error);

### milter_manager_configuration_load_custom ()

    gboolean            milter_manager_configuration_load_custom
                                                            (MilterManagerConfiguration *configuration,
                                                             const gchar *file_name,
                                                             GError **error);

### milter_manager_configuration_load_custom_if_exist ()

    gboolean            milter_manager_configuration_load_custom_if_exist
                                                            (MilterManagerConfiguration *configuration,
                                                             const gchar *file_name,
                                                             GError **error);

### milter_manager_configuration_reload ()

    gboolean            milter_manager_configuration_reload (MilterManagerConfiguration *configuration,
                                                             GError **error);

### milter_manager_configuration_save_custom ()

    gboolean            milter_manager_configuration_save_custom
                                                            (MilterManagerConfiguration *configuration,
                                                             const gchar *content,
                                                             gssize size,
                                                             GError **error);

### milter_manager_configuration_is_privilege_mode ()

    gboolean            milter_manager_configuration_is_privilege_mode
                                                            (MilterManagerConfiguration *configuration);

### milter_manager_configuration_set_privilege_mode ()

    void                milter_manager_configuration_set_privilege_mode
                                                            (MilterManagerConfiguration *configuration,
                                                             gboolean mode);

### milter_manager_configuration_get_controller_connection_spec ()

    const gchar *       milter_manager_configuration_get_controller_connection_spec
                                                            (MilterManagerConfiguration *configuration);

### milter_manager_configuration_set_controller_connection_spec ()

    void                milter_manager_configuration_set_controller_connection_spec
                                                            (MilterManagerConfiguration *configuration,
                                                             const gchar *spec);

### milter_manager_configuration_get_manager_connection_spec ()

    const gchar *       milter_manager_configuration_get_manager_connection_spec
                                                            (MilterManagerConfiguration *configuration);

### milter_manager_configuration_set_manager_connection_spec ()

    void                milter_manager_configuration_set_manager_connection_spec
                                                            (MilterManagerConfiguration *configuration,
                                                             const gchar *spec);

### milter_manager_configuration_get_effective_user ()

    const gchar *       milter_manager_configuration_get_effective_user
                                                            (MilterManagerConfiguration *configuration);

### milter_manager_configuration_set_effective_user ()

    void                milter_manager_configuration_set_effective_user
                                                            (MilterManagerConfiguration *configuration,
                                                             const gchar *user_name);

### milter_manager_configuration_get_effective_group ()

    const gchar *       milter_manager_configuration_get_effective_group
                                                            (MilterManagerConfiguration *configuration);

### milter_manager_configuration_set_effective_group ()

    void                milter_manager_configuration_set_effective_group
                                                            (MilterManagerConfiguration *configuration,
                                                             const gchar *group_name);

### milter_manager_configuration_get_manager_unix_socket_mode ()

    guint               milter_manager_configuration_get_manager_unix_socket_mode
                                                            (MilterManagerConfiguration *configuration);

### milter_manager_configuration_set_manager_unix_socket_mode ()

    void                milter_manager_configuration_set_manager_unix_socket_mode
                                                            (MilterManagerConfiguration *configuration,
                                                             guint mode);

### milter_manager_configuration_get_controller_unix_socket_mode ()

    guint               milter_manager_configuration_get_controller_unix_socket_mode
                                                            (MilterManagerConfiguration *configuration);

### milter_manager_configuration_set_controller_unix_socket_mode ()

    void                milter_manager_configuration_set_controller_unix_socket_mode
                                                            (MilterManagerConfiguration *configuration,
                                                             guint mode);

### milter_manager_configuration_get_manager_unix_socket_group ()

    const gchar *       milter_manager_configuration_get_manager_unix_socket_group
                                                            (MilterManagerConfiguration *configuration);

### milter_manager_configuration_set_manager_unix_socket_group ()

    void                milter_manager_configuration_set_manager_unix_socket_group
                                                            (MilterManagerConfiguration *configuration,
                                                             const gchar *group);

### milter_manager_configuration_is_remove_manager_unix_socket_on_close ()

    gboolean            milter_manager_configuration_is_remove_manager_unix_socket_on_close
                                                            (MilterManagerConfiguration *configuration);

### milter_manager_configuration_set_remove_manager_unix_socket_on_close ()

    void                milter_manager_configuration_set_remove_manager_unix_socket_on_close
                                                            (MilterManagerConfiguration *configuration,
                                                             gboolean remove);

### milter_manager_configuration_is_remove_controller_unix_socket_on_close ()

    gboolean            milter_manager_configuration_is_remove_controller_unix_socket_on_close
                                                            (MilterManagerConfiguration *configuration);

### milter_manager_configuration_set_remove_controller_unix_socket_on_close ()

    void                milter_manager_configuration_set_remove_controller_unix_socket_on_close
                                                            (MilterManagerConfiguration *configuration,
                                                             gboolean remove);

### milter_manager_configuration_is_remove_manager_unix_socket_on_create ()

    gboolean            milter_manager_configuration_is_remove_manager_unix_socket_on_create
                                                            (MilterManagerConfiguration *configuration);

### milter_manager_configuration_set_remove_manager_unix_socket_on_create ()

    void                milter_manager_configuration_set_remove_manager_unix_socket_on_create
                                                            (MilterManagerConfiguration *configuration,
                                                             gboolean remove);

### milter_manager_configuration_is_remove_controller_unix_socket_on_create ()

    gboolean            milter_manager_configuration_is_remove_controller_unix_socket_on_create
                                                            (MilterManagerConfiguration *configuration);

### milter_manager_configuration_set_remove_controller_unix_socket_on_create ()

    void                milter_manager_configuration_set_remove_controller_unix_socket_on_create
                                                            (MilterManagerConfiguration *configuration,
                                                             gboolean remove);

### milter_manager_configuration_is_daemon ()

    gboolean            milter_manager_configuration_is_daemon
                                                            (MilterManagerConfiguration *configuration);

### milter_manager_configuration_set_daemon ()

    void                milter_manager_configuration_set_daemon
                                                            (MilterManagerConfiguration *configuration,
                                                             gboolean daemon);

### milter_manager_configuration_get_pid_file ()

    const gchar *       milter_manager_configuration_get_pid_file
                                                            (MilterManagerConfiguration *configuration);

### milter_manager_configuration_set_pid_file ()

    void                milter_manager_configuration_set_pid_file
                                                            (MilterManagerConfiguration *configuration,
                                                             const gchar *pid_file);

### milter_manager_configuration_get_fallback_status ()

    MilterStatus        milter_manager_configuration_get_fallback_status
                                                            (MilterManagerConfiguration *configuration);

### milter_manager_configuration_set_fallback_status ()

    void                milter_manager_configuration_set_fallback_status
                                                            (MilterManagerConfiguration *configuration,
                                                             MilterStatus status);

### milter_manager_configuration_get_package_platform ()

    const gchar *       milter_manager_configuration_get_package_platform
                                                            (MilterManagerConfiguration *configuration);

### milter_manager_configuration_set_package_platform ()

    void                milter_manager_configuration_set_package_platform
                                                            (MilterManagerConfiguration *configuration,
                                                             const gchar *platform);

### milter_manager_configuration_get_package_options ()

    const gchar *       milter_manager_configuration_get_package_options
                                                            (MilterManagerConfiguration *configuration);

### milter_manager_configuration_set_package_options ()

    void                milter_manager_configuration_set_package_options
                                                            (MilterManagerConfiguration *configuration,
                                                             const gchar *options);

### milter_manager_configuration_add_egg ()

    void                milter_manager_configuration_add_egg
                                                            (MilterManagerConfiguration *configuration,
                                                             MilterManagerEgg *egg);

### milter_manager_configuration_find_egg ()

    MilterManagerEgg *  milter_manager_configuration_find_egg
                                                            (MilterManagerConfiguration *configuration,
                                                             const gchar *name);

### milter_manager_configuration_get_eggs ()

    const GList *       milter_manager_configuration_get_eggs
                                                            (MilterManagerConfiguration *configuration);

### milter_manager_configuration_remove_egg ()

    void                milter_manager_configuration_remove_egg
                                                            (MilterManagerConfiguration *configuration,
                                                             MilterManagerEgg *egg);

### milter_manager_configuration_remove_egg_by_name ()

    void                milter_manager_configuration_remove_egg_by_name
                                                            (MilterManagerConfiguration *configuration,
                                                             const gchar *name);

### milter_manager_configuration_clear_eggs ()

    void                milter_manager_configuration_clear_eggs
                                                            (MilterManagerConfiguration *configuration);

### milter_manager_configuration_add_applicable_condition ()

    void                milter_manager_configuration_add_applicable_condition
                                                            (MilterManagerConfiguration *configuration,
                                                             MilterManagerApplicableCondition *condition);

### milter_manager_configuration_find_applicable_condition ()

    MilterManagerApplicableCondition * milter_manager_configuration_find_applicable_condition
                                                            (MilterManagerConfiguration *configuration,
                                                             const gchar *name);

### milter_manager_configuration_get_applicable_conditions ()

    const GList *       milter_manager_configuration_get_applicable_conditions
                                                            (MilterManagerConfiguration *configuration);

### milter_manager_configuration_remove_applicable_condition ()

    void                milter_manager_configuration_remove_applicable_condition
                                                            (MilterManagerConfiguration *configuration,
                                                             MilterManagerApplicableCondition *condition);

### milter_manager_configuration_remove_applicable_condition_by_name ()

    void                milter_manager_configuration_remove_applicable_condition_by_name
                                                            (MilterManagerConfiguration *configuration,
                                                             const gchar *name);

### milter_manager_configuration_clear_applicable_conditions ()

    void                milter_manager_configuration_clear_applicable_conditions
                                                            (MilterManagerConfiguration *configuration);

### milter_manager_configuration_clear ()

    gboolean            milter_manager_configuration_clear  (MilterManagerConfiguration *configuration,
                                                             GError **error);

### milter_manager_configuration_to_xml ()

    gchar *             milter_manager_configuration_to_xml (MilterManagerConfiguration *configuration);

### milter_manager_configuration_to_xml_string ()

    void                milter_manager_configuration_to_xml_string
                                                            (MilterManagerConfiguration *configuration,
                                                             GString *string,
                                                             guint indent);

### milter_manager_configuration_dump ()

    gchar *             milter_manager_configuration_dump   (MilterManagerConfiguration *configuration);