MilterManagerEgg 3 MILTER-MANAGER Library
MilterManagerEgg

## Functions

GQuark | milter_manager_egg_error_quark ()
MilterManagerEgg * | milter_manager_egg_new ()
MilterManagerChild * | milter_manager_egg_hatch ()
void | milter_manager_egg_set_name ()
const gchar * | milter_manager_egg_get_name ()
void | milter_manager_egg_set_description ()
const gchar * | milter_manager_egg_get_description ()
void | milter_manager_egg_set_enabled ()
gboolean | milter_manager_egg_is_enabled ()
gboolean | milter_manager_egg_set_connection_spec ()
const gchar * | milter_manager_egg_get_connection_spec ()
void | milter_manager_egg_set_connection_timeout ()
gdouble | milter_manager_egg_get_connection_timeout ()
void | milter_manager_egg_set_writing_timeout ()
gdouble | milter_manager_egg_get_writing_timeout ()
void | milter_manager_egg_set_reading_timeout ()
gdouble | milter_manager_egg_get_reading_timeout ()
void | milter_manager_egg_set_end_of_message_timeout ()
gdouble | milter_manager_egg_get_end_of_message_timeout ()
void | milter_manager_egg_set_user_name ()
const gchar * | milter_manager_egg_get_user_name ()
void | milter_manager_egg_set_command ()
const gchar * | milter_manager_egg_get_command ()
void | milter_manager_egg_set_command_options ()
const gchar * | milter_manager_egg_get_command_options ()
void | milter_manager_egg_set_fallback_status ()
MilterStatus | milter_manager_egg_get_fallback_status ()
void | milter_manager_egg_set_evaluation_mode ()
gboolean | milter_manager_egg_is_evaluation_mode ()
void | milter_manager_egg_add_applicable_condition ()
const GList * | milter_manager_egg_get_applicable_conditions ()
void | milter_manager_egg_clear_applicable_conditions ()
void | milter_manager_egg_attach_applicable_conditions ()
gboolean | milter_manager_egg_merge ()
gchar * | milter_manager_egg_to_xml ()
void | milter_manager_egg_to_xml_string ()

## Properties

char * | command | Read / Write
char * | command-options | Read / Write
char * | connection-spec | Read
double | connection-timeout | Read / Write
char * | description | Read / Write
gboolean | enabled | Read / Write
double | end-of-message-timeout | Read / Write
gboolean | evaluation-mode | Read / Write
MilterStatus | fallback-status | Read / Write
char * | name | Read / Write
double | reading-timeout | Read / Write
char * | user-name | Read / Write
double | writing-timeout | Read / Write

## Signals

void | hatched | Run Last
void | to-xml | Run Last

## Types and Values

#define | MILTER_MANAGER_EGG_ERROR
enum | MilterManagerEggError
| MilterManagerEgg
struct | MilterManagerEggClass

## Object Hierarchy

        GObject
        ╰── MilterManagerEgg

## Implemented Interfaces

MilterManagerEgg implements

## Description

## Functions

### milter_manager_egg_error_quark ()

    GQuark
    milter_manager_egg_error_quark (void);

milter_manager_egg_error_quark

### milter_manager_egg_new ()

    MilterManagerEgg *
    milter_manager_egg_new (const gchar *name);

milter_manager_egg_new

### milter_manager_egg_hatch ()

    MilterManagerChild *
    milter_manager_egg_hatch (MilterManagerEgg *egg);

#### Parameters

egg | A MilterManagerEgg. |

#### Returns

A newly created milter manager egg hatch.

[transfer full][nullable]

milter_manager_egg_hatch

### milter_manager_egg_set_name ()

    void
    milter_manager_egg_set_name (MilterManagerEgg *egg,
                                 const gchar *name);

milter_manager_egg_set_name

### milter_manager_egg_get_name ()

    const gchar *
    milter_manager_egg_get_name (MilterManagerEgg *egg);

milter_manager_egg_get_name

### milter_manager_egg_set_description ()

    void
    milter_manager_egg_set_description (MilterManagerEgg *egg,
                                        const gchar *description);

milter_manager_egg_set_description

### milter_manager_egg_get_description ()

    const gchar *
    milter_manager_egg_get_description (MilterManagerEgg *egg);

milter_manager_egg_get_description

### milter_manager_egg_set_enabled ()

    void
    milter_manager_egg_set_enabled (MilterManagerEgg *egg,
                                    gboolean enabled);

milter_manager_egg_set_enabled

### milter_manager_egg_is_enabled ()

    gboolean
    milter_manager_egg_is_enabled (MilterManagerEgg *egg);

milter_manager_egg_is_enabled

### milter_manager_egg_set_connection_spec ()

    gboolean
    milter_manager_egg_set_connection_spec
                                   (MilterManagerEgg *egg,
                                    const gchar *connection_spec,
                                    GError **error);

milter_manager_egg_set_connection_spec

### milter_manager_egg_get_connection_spec ()

    const gchar *
    milter_manager_egg_get_connection_spec
                                   (MilterManagerEgg *egg);

milter_manager_egg_get_connection_spec

### milter_manager_egg_set_connection_timeout ()

    void
    milter_manager_egg_set_connection_timeout
                                   (MilterManagerEgg *egg,
                                    gdouble connection_timeout);

milter_manager_egg_set_connection_timeout

### milter_manager_egg_get_connection_timeout ()

    gdouble
    milter_manager_egg_get_connection_timeout
                                   (MilterManagerEgg *egg);

milter_manager_egg_get_connection_timeout

### milter_manager_egg_set_writing_timeout ()

    void
    milter_manager_egg_set_writing_timeout
                                   (MilterManagerEgg *egg,
                                    gdouble writing_timeout);

milter_manager_egg_set_writing_timeout

### milter_manager_egg_get_writing_timeout ()

    gdouble
    milter_manager_egg_get_writing_timeout
                                   (MilterManagerEgg *egg);

milter_manager_egg_get_writing_timeout

### milter_manager_egg_set_reading_timeout ()

    void
    milter_manager_egg_set_reading_timeout
                                   (MilterManagerEgg *egg,
                                    gdouble reading_timeout);

milter_manager_egg_set_reading_timeout

### milter_manager_egg_get_reading_timeout ()

    gdouble
    milter_manager_egg_get_reading_timeout
                                   (MilterManagerEgg *egg);

milter_manager_egg_get_reading_timeout

### milter_manager_egg_set_end_of_message_timeout ()

    void
    milter_manager_egg_set_end_of_message_timeout
                                   (MilterManagerEgg *egg,
                                    gdouble end_of_message_timeout);

milter_manager_egg_set_end_of_message_timeout

### milter_manager_egg_get_end_of_message_timeout ()

    gdouble
    milter_manager_egg_get_end_of_message_timeout
                                   (MilterManagerEgg *egg);

milter_manager_egg_get_end_of_message_timeout

### milter_manager_egg_set_user_name ()

    void
    milter_manager_egg_set_user_name (MilterManagerEgg *egg,
                                      const gchar *user_name);

milter_manager_egg_set_user_name

### milter_manager_egg_get_user_name ()

    const gchar *
    milter_manager_egg_get_user_name (MilterManagerEgg *egg);

milter_manager_egg_get_user_name

### milter_manager_egg_set_command ()

    void
    milter_manager_egg_set_command (MilterManagerEgg *egg,
                                    const gchar *command);

milter_manager_egg_set_command

### milter_manager_egg_get_command ()

    const gchar *
    milter_manager_egg_get_command (MilterManagerEgg *egg);

milter_manager_egg_get_command

### milter_manager_egg_set_command_options ()

    void
    milter_manager_egg_set_command_options
                                   (MilterManagerEgg *egg,
                                    const gchar *command_options);

milter_manager_egg_set_command_options

### milter_manager_egg_get_command_options ()

    const gchar *
    milter_manager_egg_get_command_options
                                   (MilterManagerEgg *egg);

milter_manager_egg_get_command_options

### milter_manager_egg_set_fallback_status ()

    void
    milter_manager_egg_set_fallback_status
                                   (MilterManagerEgg *egg,
                                    MilterStatus status);

milter_manager_egg_set_fallback_status

### milter_manager_egg_get_fallback_status ()

    MilterStatus
    milter_manager_egg_get_fallback_status
                                   (MilterManagerEgg *egg);

milter_manager_egg_get_fallback_status

### milter_manager_egg_set_evaluation_mode ()

    void
    milter_manager_egg_set_evaluation_mode
                                   (MilterManagerEgg *egg,
                                    gboolean evaluation_mode);

milter_manager_egg_set_evaluation_mode

### milter_manager_egg_is_evaluation_mode ()

    gboolean
    milter_manager_egg_is_evaluation_mode (MilterManagerEgg *egg);

milter_manager_egg_is_evaluation_mode

### milter_manager_egg_add_applicable_condition ()

    void
    milter_manager_egg_add_applicable_condition
                                   (MilterManagerEgg *egg,
                                    MilterManagerApplicableCondition *condition);

milter_manager_egg_add_applicable_condition

### milter_manager_egg_get_applicable_conditions ()

    const GList *
    milter_manager_egg_get_applicable_conditions
                                   (MilterManagerEgg *egg);

#### Parameters

egg | A MilterManagerEgg. |

#### Returns

A list of MilterManagerApplicableCondition.

[transfer none][element-type MilterManagerApplicableCondition]

milter_manager_egg_get_applicable_conditions

### milter_manager_egg_clear_applicable_conditions ()

    void
    milter_manager_egg_clear_applicable_conditions
                                   (MilterManagerEgg *egg);

milter_manager_egg_clear_applicable_conditions

### milter_manager_egg_attach_applicable_conditions ()

    void
    milter_manager_egg_attach_applicable_conditions
                                   (MilterManagerEgg *egg,
                                    MilterManagerChild *child,
                                    MilterManagerChildren *children,
                                    MilterClientContext *context);

milter_manager_egg_attach_applicable_conditions

### milter_manager_egg_merge ()

    gboolean
    milter_manager_egg_merge (MilterManagerEgg *egg,
                              MilterManagerEgg *other_egg,
                              GError **error);

milter_manager_egg_merge

### milter_manager_egg_to_xml ()

    gchar *
    milter_manager_egg_to_xml (MilterManagerEgg *egg);

milter_manager_egg_to_xml

### milter_manager_egg_to_xml_string ()

    void
    milter_manager_egg_to_xml_string (MilterManagerEgg *egg,
                                      GString *string,
                                      guint indent);

milter_manager_egg_to_xml_string

## Types and Values

### MILTER_MANAGER_EGG_ERROR

    #define MILTER_MANAGER_EGG_ERROR           (milter_manager_egg_error_quark())

MILTER_MANAGER_EGG_ERROR

### enum MilterManagerEggError

#### Members

MILTER_MANAGER_EGG_ERROR_INVALID |  |

MilterManagerEggError

### MilterManagerEgg

    typedef struct _MilterManagerEgg MilterManagerEgg;

MilterManagerEgg

### struct MilterManagerEggClass

    struct MilterManagerEggClass {
        GObjectClass parent_class;

        void (*hatched) (MilterManagerEgg   *egg,
                         MilterManagerChild *child);
        void (*to_xml)  (MilterManagerEgg   *egg,
                         GString            *xml,
                         guint               indent);
    };

MilterManagerEggClass

## Property Details

### The `“command”` property

      “command”                  char *

The command of the milter egg.

Owner: MilterManagerEgg

Flags: Read / Write

Default value: NULL

MilterManagerEgg:command

### The `“command-options”` property

      “command-options”          char *

The command options string of the milter egg.

Owner: MilterManagerEgg

Flags: Read / Write

Default value: NULL

MilterManagerEgg:command-options

### The `“connection-spec”` property

      “connection-spec”          char *

The connection spec of the milter egg.

Owner: MilterManagerEgg

Flags: Read

Default value: NULL

MilterManagerEgg:connection-spec

### The `“connection-timeout”` property

      “connection-timeout”       double

The connection timeout of the milter egg.

Owner: MilterManagerEgg

Flags: Read / Write

Allowed values: >= 0

Default value: 297

MilterManagerEgg:connection-timeout

### The `“description”` property

      “description”              char *

The description of the milter egg.

Owner: MilterManagerEgg

Flags: Read / Write

Default value: NULL

MilterManagerEgg:description

### The `“enabled”` property

      “enabled”                  gboolean

Whether the milter egg is enabled or not.

Owner: MilterManagerEgg

Flags: Read / Write

Default value: TRUE

MilterManagerEgg:enabled

### The `“end-of-message-timeout”` property

      “end-of-message-timeout”   double

The end-of-message timeout of the milter egg.

Owner: MilterManagerEgg

Flags: Read / Write

Allowed values: >= 0

Default value: 297

MilterManagerEgg:end-of-message-timeout

### The `“evaluation-mode”` property

      “evaluation-mode”          gboolean

Whether the milter's result is ignored or not.

Owner: MilterManagerEgg

Flags: Read / Write

Default value: FALSE

MilterManagerEgg:evaluation-mode

### The `“fallback-status”` property

      “fallback-status”          MilterStatus

Fallback status on error.

Owner: MilterManagerEgg

Flags: Read / Write

Default value: MILTER_STATUS_ACCEPT

MilterManagerEgg:fallback-status

### The `“name”` property

      “name”                     char *

The name of the milter egg.

Owner: MilterManagerEgg

Flags: Read / Write

Default value: NULL

MilterManagerEgg:name

### The `“reading-timeout”` property

      “reading-timeout”          double

The reading timeout of the milter egg.

Owner: MilterManagerEgg

Flags: Read / Write

Allowed values: >= 0

Default value: 7

MilterManagerEgg:reading-timeout

### The `“user-name”` property

      “user-name”                char *

The user name of a egged milter.

Owner: MilterManagerEgg

Flags: Read / Write

Default value: NULL

MilterManagerEgg:user-name

### The `“writing-timeout”` property

      “writing-timeout”          double

The writing timeout of the milter egg.

Owner: MilterManagerEgg

Flags: Read / Write

Allowed values: >= 0

Default value: 7

MilterManagerEgg:writing-timeout

## Signal Details

### The `“hatched”` signal

    void
    user_function (MilterManagerEgg   *miltermanageregg,
                   MilterManagerChild *arg1,
                   gpointer            user_data)

Flags: Run Last

MilterManagerEgg::hatched

### The `“to-xml”` signal

    void
    user_function (MilterManagerEgg *miltermanageregg,
                   gpointer          arg1,
                   guint             arg2,
                   gpointer          user_data)

Flags: Run Last

MilterManagerEgg::to-xml