milter-manager-objects 3 MILTER-MANAGER Library
milter-manager-objects

## Properties

char * | data | Read / Write
char * | description | Read / Write
char * | name | Read / Write
MilterManagerConfiguration * | configuration | Read / Write / Construct Only
MilterEventLoop * | event-loop | Read / Write / Construct Only
guint | tag | Read
guint | chunk-size | Read / Write / Construct
guint | connection-check-interval | Read / Write / Construct
char * | controller-connection-spec | Read / Write / Construct
char * | controller-unix-socket-group | Read / Write / Construct
guint | controller-unix-socket-mode | Read / Write / Construct
char * | custom-configuration-directory | Read / Write / Construct
gboolean | daemon | Read / Write / Construct
guint | default-packet-buffer-size | Read / Write
char * | effective-group | Read / Write / Construct
char * | effective-user | Read / Write / Construct
MilterClientEventLoopBackend | event-loop-backend | Read / Write
MilterStatus | fallback-status | Read / Write / Construct
MilterStatus | fallback-status-at-disconnect | Read / Write / Construct
guint | maintenance-interval | Read / Write / Construct
char * | manager-connection-spec | Read / Write / Construct
char * | manager-unix-socket-group | Read / Write / Construct
guint | manager-unix-socket-mode | Read / Write / Construct
guint | max-connections | Read / Write / Construct
guint | max-file-descriptors | Read / Write / Construct
guint | max-pending-finished-sessions | Read / Write
guint | n-workers | Read / Write
char * | package-options | Read / Write / Construct
char * | package-platform | Read / Write / Construct
char * | pid-file | Read / Write / Construct
char * | prefix | Read
gboolean | privilege-mode | Read / Write / Construct
gboolean | remove-controller-unix-socket-on-close | Read / Write / Construct
gboolean | remove-controller-unix-socket-on-create | Read / Write / Construct
gboolean | remove-manager-unix-socket-on-close | Read / Write / Construct
gboolean | remove-manager-unix-socket-on-create | Read / Write / Construct
guint | suspend-time-on-unacceptable | Read / Write / Construct
char * | syslog-facility | Read / Write / Construct
gboolean | use-syslog | Read / Write / Construct
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
MilterManagerChildren * | children | Read
MilterClientContext * | client-context | Read / Write
MilterManagerConfiguration * | configuration | Read / Write

## Signals

void | attach-to | Run Last
void | connected | Run Last
void | to-xml | Run Last
void | hatched | Run Last
void | to-xml | Run Last
gboolean | connection-check | Run Last

## Types and Values

| MilterManagerApplicableCondition
| MilterManagerChildren
| MilterManagerConfiguration
| MilterManagerEgg
| MilterManagerLeader

## Object Hierarchy

        GObject
        ├── MilterManagerApplicableCondition
        ├── MilterManagerChildren
        ├── MilterManagerConfiguration
        ├── MilterManagerEgg
        ╰── MilterManagerLeader

## Implemented Interfaces

MilterManagerChildren implements

MilterManagerEgg implements

MilterManagerLeader implements

## Description

## Functions

## Types and Values

### MilterManagerApplicableCondition

    typedef struct _MilterManagerApplicableCondition MilterManagerApplicableCondition;

MilterManagerApplicableCondition

### MilterManagerChildren

    typedef struct _MilterManagerChildren MilterManagerChildren;

MilterManagerChildren

### MilterManagerConfiguration

    typedef struct _MilterManagerConfiguration MilterManagerConfiguration;

MilterManagerConfiguration

### MilterManagerEgg

    typedef struct _MilterManagerEgg MilterManagerEgg;

MilterManagerEgg

### MilterManagerLeader

    typedef struct _MilterManagerLeader MilterManagerLeader;

MilterManagerLeader

## Property Details

### The `“data”` property

      “data”                     char *

The data of the applicable condition.

Owner: MilterManagerApplicableCondition

Flags: Read / Write

Default value: NULL

MilterManagerApplicableCondition:data

### The `“description”` property

      “description”              char *

The description of the applicable condition.

Owner: MilterManagerApplicableCondition

Flags: Read / Write

Default value: NULL

MilterManagerApplicableCondition:description

### The `“name”` property

      “name”                     char *

The name of the applicable condition.

Owner: MilterManagerApplicableCondition

Flags: Read / Write

Default value: NULL

MilterManagerApplicableCondition:name

### The `“configuration”` property

      “configuration”            MilterManagerConfiguration *

The configuration of the milter controller.

Owner: MilterManagerChildren

Flags: Read / Write / Construct Only

MilterManagerChildren:configuration

### The `“event-loop”` property

      “event-loop”               MilterEventLoop *

The event loop of the milter controller.

Owner: MilterManagerChildren

Flags: Read / Write / Construct Only

MilterManagerChildren:event-loop

### The `“tag”` property

      “tag”                      guint

The tag of the agent.

Owner: MilterManagerChildren

Flags: Read

Default value: 0

MilterManagerChildren:tag

### The `“chunk-size”` property

      “chunk-size”               guint

The chunk size of the milter-manager.

Owner: MilterManagerConfiguration

Flags: Read / Write / Construct

Allowed values: [1,65535]

Default value: 65535

MilterManagerConfiguration:chunk-size

### The `“connection-check-interval”` property

      “connection-check-interval” guint

The interval in seconds for checking whether SMTP connection between SMTP client and server is still connected or disconnected from SMTP client.

Owner: MilterManagerConfiguration

Flags: Read / Write / Construct

Default value: 0

MilterManagerConfiguration:connection-check-interval

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

      “controller-connection-spec” char *

The controller connection spec of the milter-manager.

Owner: MilterManagerConfiguration

Flags: Read / Write / Construct

Default value: NULL

MilterManagerConfiguration:controller-connection-spec

### The `“controller-unix-socket-group”` property

      “controller-unix-socket-group” char *

The milter-manager controller's UNIX socket group.

Owner: MilterManagerConfiguration

Flags: Read / Write / Construct

Default value: NULL

MilterManagerConfiguration:controller-unix-socket-group

### The `“controller-unix-socket-mode”` property

      “controller-unix-socket-mode” guint

The milter-manager controller's UNIX socket mode.

Owner: MilterManagerConfiguration

Flags: Read / Write / Construct

Allowed values: <= 511

Default value: 432

MilterManagerConfiguration:controller-unix-socket-mode

### The `“custom-configuration-directory”` property

      “custom-configuration-directory” char *

The directory for custom configuration.

Owner: MilterManagerConfiguration

Flags: Read / Write / Construct

Default value: NULL

MilterManagerConfiguration:custom-configuration-directory

### The `“daemon”` property

      “daemon”                   gboolean

Whether milter-manager runs as daemon process.

Owner: MilterManagerConfiguration

Flags: Read / Write / Construct

Default value: FALSE

MilterManagerConfiguration:daemon

### The `“default-packet-buffer-size”` property

      “default-packet-buffer-size” guint

The default packet buffer size of client contexts of the client.

Owner: MilterManagerConfiguration

Flags: Read / Write

Default value: 0

MilterManagerConfiguration:default-packet-buffer-size

### The `“effective-group”` property

      “effective-group”          char *

The effective group name of the milter-manager.

Owner: MilterManagerConfiguration

Flags: Read / Write / Construct

Default value: NULL

MilterManagerConfiguration:effective-group

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

      “effective-user”           char *

The effective user name of the milter-manager.

Owner: MilterManagerConfiguration

Flags: Read / Write / Construct

Default value: NULL

MilterManagerConfiguration:effective-user

### The `“event-loop-backend”` property

      “event-loop-backend”       MilterClientEventLoopBackend

The event loop backend of the configuration.

Owner: MilterManagerConfiguration

Flags: Read / Write

Default value: MILTER_CLIENT_EVENT_LOOP_BACKEND_GLIB

MilterManagerConfiguration:event-loop-backend

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

      “fallback-status”          MilterStatus

The fallback status of the milter-manager.

Owner: MilterManagerConfiguration

Flags: Read / Write / Construct

Default value: MILTER_STATUS_ACCEPT

MilterManagerConfiguration:fallback-status

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

      “fallback-status-at-disconnect” MilterStatus

The fallback status at disconnect of the milter-manager.

Owner: MilterManagerConfiguration

Flags: Read / Write / Construct

Default value: MILTER_STATUS_TEMPORARY_FAILURE

MilterManagerConfiguration:fallback-status-at-disconnect

### The `“maintenance-interval”` property

      “maintenance-interval”     guint

Run maintenance process in after each N sessions. 0 means that periodical maintenance process isn't run.

Owner: MilterManagerConfiguration

Flags: Read / Write / Construct

Default value: 10

MilterManagerConfiguration:maintenance-interval

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

      “manager-connection-spec”  char *

The manager connection spec of the milter-manager.

Owner: MilterManagerConfiguration

Flags: Read / Write / Construct

Default value: "unix:/run/milter-manager/milter-manager.sock"

MilterManagerConfiguration:manager-connection-spec

### The `“manager-unix-socket-group”` property

      “manager-unix-socket-group” char *

The milter-manager's UNIX socket group.

Owner: MilterManagerConfiguration

Flags: Read / Write / Construct

Default value: NULL

MilterManagerConfiguration:manager-unix-socket-group

### The `“manager-unix-socket-mode”` property

      “manager-unix-socket-mode” guint

The milter-manager's UNIX socket mode.

Owner: MilterManagerConfiguration

Flags: Read / Write / Construct

Allowed values: <= 511

Default value: 432

MilterManagerConfiguration:manager-unix-socket-mode

### The `“max-connections”` property

      “max-connections”          guint

Max number of concurrent connections.

Owner: MilterManagerConfiguration

Flags: Read / Write / Construct

Default value: 0

MilterManagerConfiguration:max-connections

### The `“max-file-descriptors”` property

      “max-file-descriptors”     guint

Max number of concurrent file descriptors.

Owner: MilterManagerConfiguration

Flags: Read / Write / Construct

Default value: 0

MilterManagerConfiguration:max-file-descriptors

### The `“max-pending-finished-sessions”` property

      “max-pending-finished-sessions” guint

The maximum number of pending finished sessions of milter-manager.

Owner: MilterManagerConfiguration

Flags: Read / Write

Default value: 0

MilterManagerConfiguration:max-pending-finished-sessions

### The `“n-workers”` property

      “n-workers”                guint

The number of worker processes of the client.

Owner: MilterManagerConfiguration

Flags: Read / Write

Allowed values: <= 1000

Default value: 0

MilterManagerConfiguration:n-workers

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

      “package-options”          char *

The package options of the milter-manager.

Owner: MilterManagerConfiguration

Flags: Read / Write / Construct

Default value: NULL

MilterManagerConfiguration:package-options

### The `“package-platform”` property

      “package-platform”         char *

The package platform of the milter-manager.

Owner: MilterManagerConfiguration

Flags: Read / Write / Construct

Default value: "debian"

MilterManagerConfiguration:package-platform

### The `“pid-file”` property

      “pid-file”                 char *

The file name to be saved process ID.

Owner: MilterManagerConfiguration

Flags: Read / Write / Construct

Default value: NULL

MilterManagerConfiguration:pid-file

### The `“prefix”` property

      “prefix”                   char *

The prefix of install directory.

Owner: MilterManagerConfiguration

Flags: Read

Default value: NULL

MilterManagerConfiguration:prefix

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

      “privilege-mode”           gboolean

Whether MilterManager runs on privilege mode.

Owner: MilterManagerConfiguration

Flags: Read / Write / Construct

Default value: FALSE

MilterManagerConfiguration:privilege-mode

### The `“remove-controller-unix-socket-on-close”` property

      “remove-controller-unix-socket-on-close” gboolean

Whether milter-manager removes UNIX socket used for controller on close.

Owner: MilterManagerConfiguration

Flags: Read / Write / Construct

Default value: TRUE

MilterManagerConfiguration:remove-controller-unix-socket-on-close

### The `“remove-controller-unix-socket-on-create”` property

      “remove-controller-unix-socket-on-create” gboolean

Whether milter-manager removes UNIX socket used for controller on create.

Owner: MilterManagerConfiguration

Flags: Read / Write / Construct

Default value: TRUE

MilterManagerConfiguration:remove-controller-unix-socket-on-create

### The `“remove-manager-unix-socket-on-close”` property

      “remove-manager-unix-socket-on-close” gboolean

Whether milter-manager removes UNIX socket used for manager on close.

Owner: MilterManagerConfiguration

Flags: Read / Write / Construct

Default value: TRUE

MilterManagerConfiguration:remove-manager-unix-socket-on-close

### The `“remove-manager-unix-socket-on-create”` property

      “remove-manager-unix-socket-on-create” gboolean

Whether milter-manager removes UNIX socket used for manager on create.

Owner: MilterManagerConfiguration

Flags: Read / Write / Construct

Default value: TRUE

MilterManagerConfiguration:remove-manager-unix-socket-on-create

### The `“suspend-time-on-unacceptable”` property

      “suspend-time-on-unacceptable” guint

Suspend time on unacceptable.

Owner: MilterManagerConfiguration

Flags: Read / Write / Construct

Default value: 5

MilterManagerConfiguration:suspend-time-on-unacceptable

### The `“syslog-facility”` property

      “syslog-facility”          char *

The syslog facility of the milter-manager.

Owner: MilterManagerConfiguration

Flags: Read / Write / Construct

Default value: NULL

MilterManagerConfiguration:syslog-facility

### The `“use-syslog”` property

      “use-syslog”               gboolean

Whether milter-manager uses syslog.

Owner: MilterManagerConfiguration

Flags: Read / Write / Construct

Default value: TRUE

MilterManagerConfiguration:use-syslog

### 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

### The `“children”` property

      “children”                 MilterManagerChildren *

The object manages child milters.

Owner: MilterManagerLeader

Flags: Read

MilterManagerLeader:children

### The `“client-context”` property

      “client-context”           MilterClientContext *

The client context of the milter leader.

Owner: MilterManagerLeader

Flags: Read / Write

MilterManagerLeader:client-context

### The `“configuration”` property

      “configuration”            MilterManagerConfiguration *

The configuration of the milter leader.

Owner: MilterManagerLeader

Flags: Read / Write

MilterManagerLeader:configuration

## Signal Details

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

    void
    user_function (MilterManagerApplicableCondition *miltermanagerapplicablecondition,
                   MilterManagerChild               *arg1,
                   MilterManagerChildren            *arg2,
                   MilterClientContext              *arg3,
                   gpointer                          user_data)

Flags: Run Last

MilterManagerApplicableCondition::attach-to

### The `“connected”` signal

    void
    user_function (MilterManagerConfiguration *miltermanagerconfiguration,
                   MilterManagerLeader        *arg1,
                   gpointer                    user_data)

Flags: Run Last

MilterManagerConfiguration::connected

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

    void
    user_function (MilterManagerConfiguration *miltermanagerconfiguration,
                   gpointer                    arg1,
                   guint                       arg2,
                   gpointer                    user_data)

Flags: Run Last

MilterManagerConfiguration::to-xml

### 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

### The `“connection-check”` signal

    gboolean
    user_function (MilterManagerLeader *miltermanagerleader,
                   gpointer             user_data)

Flags: Run Last

MilterManagerLeader::connection-check