<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="milter-manager-milter-agent">
<refmeta>
<refentrytitle role="top_of_page" id="milter-manager-milter-agent.top_of_page">MilterAgent</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>milter managerライブラリ</refmiscinfo>
</refmeta>
<refnamediv>
<refname>MilterAgent</refname>
<refpurpose/>
</refnamediv>

<refsect1 id="milter-manager-milter-agent.functions" role="functions_proto">
<title role="functions_proto.title">Functions</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="functions_return" colwidth="150px"/>
<colspec colname="functions_name"/>
<tbody>
<row><entry role="define_keyword">#define</entry><entry role="function_name"><link linkend="MILTER-AGENT-ERROR:CAPS">MILTER_AGENT_ERROR</link></entry></row>
<row><entry role="function_type"><link linkend="GQuark"><returnvalue>GQuark</returnvalue></link>
</entry><entry role="function_name"><link linkend="milter-agent-error-quark">milter_agent_error_quark</link> <phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="MilterEncoder"><returnvalue>MilterEncoder</returnvalue></link> *
</entry><entry role="function_name"><link linkend="milter-agent-get-encoder">milter_agent_get_encoder</link> <phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="MilterDecoder"><returnvalue>MilterDecoder</returnvalue></link> *
</entry><entry role="function_name"><link linkend="milter-agent-get-decoder">milter_agent_get_decoder</link> <phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="milter-agent-set-writer">milter_agent_set_writer</link> <phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="milter-agent-set-reader">milter_agent_set_reader</link> <phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="milter-agent-write-packet">milter_agent_write_packet</link> <phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="milter-agent-flush">milter_agent_flush</link> <phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="milter-agent-start">milter_agent_start</link> <phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="milter-agent-shutdown">milter_agent_shutdown</link> <phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<anchor id="MilterAgent"/><refsect1 id="milter-manager-milter-agent.other" role="other_proto">
<title role="other_proto.title">Types and Values</title>
<informaltable role="enum_members_table" pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="name" colwidth="150px"/>
<colspec colname="description"/>
<tbody>
<row><entry role="datatype_keyword">enum</entry><entry role="function_name"><link linkend="MilterAgentError">MilterAgentError</link></entry></row>
<row><entry role="datatype_keyword">struct</entry><entry role="function_name"><link linkend="MilterAgent-struct">MilterAgent</link></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="milter-manager-milter-agent.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">オブジェクト階層</title>
<screen>    <link linkend="GObject">GObject</link>
    <phrase role="lineart">╰──</phrase> MilterAgent
        <phrase role="lineart">╰──</phrase> <link linkend="MilterProtocolAgent">MilterProtocolAgent</link>
</screen>
</refsect1>
<refsect1 id="milter-manager-milter-agent.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">実装されたインターフェイス</title>
<para>MilterAgentは<link linkend="MilterErrorEmittable">MilterErrorEmittable</link>と<link linkend="MilterFinishedEmittable">MilterFinishedEmittable</link>を実装しています。</para>

</refsect1>


<refsect1 id="milter-manager-milter-agent.description" role="desc">
<title role="desc.title">説明</title>
<para>
</para>

</refsect1>
<refsect1 id="milter-manager-milter-agent.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="MILTER-AGENT-ERROR:CAPS" role="macro">
<title>MILTER_AGENT_ERROR</title>
<indexterm zone="MILTER-AGENT-ERROR:CAPS"><primary>MILTER_AGENT_ERROR</primary></indexterm>
<programlisting language="C">#define MILTER_AGENT_ERROR           (milter_agent_error_quark())
</programlisting>
<para>
</para>
</refsect2>
<refsect2 id="milter-agent-error-quark" role="function">
<title>milter_agent_error_quark ()</title>
<indexterm zone="milter-agent-error-quark"><primary>milter_agent_error_quark</primary></indexterm>
<programlisting language="C"><link linkend="GQuark"><returnvalue>GQuark</returnvalue></link>
milter_agent_error_quark (<parameter><type>void</type></parameter>);</programlisting>
<para>
</para>
<refsect3 role="returns">
<title>Returns</title>

<para/>
</refsect3></refsect2>
<refsect2 id="milter-agent-get-encoder" role="function">
<title>milter_agent_get_encoder ()</title>
<indexterm zone="milter-agent-get-encoder"><primary>milter_agent_get_encoder</primary></indexterm>
<programlisting language="C"><link linkend="MilterEncoder"><returnvalue>MilterEncoder</returnvalue></link> *
milter_agent_get_encoder (<parameter><link linkend="MilterAgent"><type>MilterAgent</type></link> *agent</parameter>);</programlisting>
<para>
</para>
<refsect3 role="returns">
<title>Returns</title>

<para/>
</refsect3></refsect2>
<refsect2 id="milter-agent-get-decoder" role="function">
<title>milter_agent_get_decoder ()</title>
<indexterm zone="milter-agent-get-decoder"><primary>milter_agent_get_decoder</primary></indexterm>
<programlisting language="C"><link linkend="MilterDecoder"><returnvalue>MilterDecoder</returnvalue></link> *
milter_agent_get_decoder (<parameter><link linkend="MilterAgent"><type>MilterAgent</type></link> *agent</parameter>);</programlisting>
<para>
</para>
<refsect3 role="returns">
<title>Returns</title>

<para/>
</refsect3></refsect2>
<refsect2 id="milter-agent-set-writer" role="function">
<title>milter_agent_set_writer ()</title>
<indexterm zone="milter-agent-set-writer"><primary>milter_agent_set_writer</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
milter_agent_set_writer (<parameter><link linkend="MilterAgent"><type>MilterAgent</type></link> *agent</parameter>,
                         <parameter><link linkend="MilterWriter"><type>MilterWriter</type></link> *writer</parameter>);</programlisting>
<para>
</para>
</refsect2>
<refsect2 id="milter-agent-set-reader" role="function">
<title>milter_agent_set_reader ()</title>
<indexterm zone="milter-agent-set-reader"><primary>milter_agent_set_reader</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
milter_agent_set_reader (<parameter><link linkend="MilterAgent"><type>MilterAgent</type></link> *agent</parameter>,
                         <parameter><link linkend="MilterReader"><type>MilterReader</type></link> *reader</parameter>);</programlisting>
<para>
</para>
</refsect2>
<refsect2 id="milter-agent-write-packet" role="function">
<title>milter_agent_write_packet ()</title>
<indexterm zone="milter-agent-write-packet"><primary>milter_agent_write_packet</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
milter_agent_write_packet (<parameter><link linkend="MilterAgent"><type>MilterAgent</type></link> *agent</parameter>,
                           <parameter>const <link linkend="char"><type>char</type></link> *packet</parameter>,
                           <parameter><link linkend="gsize"><type>gsize</type></link> packet_size</parameter>,
                           <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
<para>
</para>
<refsect3 role="returns">
<title>Returns</title>

<para/>
</refsect3></refsect2>
<refsect2 id="milter-agent-flush" role="function">
<title>milter_agent_flush ()</title>
<indexterm zone="milter-agent-flush"><primary>milter_agent_flush</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
milter_agent_flush (<parameter><link linkend="MilterAgent"><type>MilterAgent</type></link> *agent</parameter>,
                    <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
<para>
</para>
<refsect3 role="returns">
<title>Returns</title>

<para/>
</refsect3></refsect2>
<refsect2 id="milter-agent-start" role="function">
<title>milter_agent_start ()</title>
<indexterm zone="milter-agent-start"><primary>milter_agent_start</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
milter_agent_start (<parameter><link linkend="MilterAgent"><type>MilterAgent</type></link> *agent</parameter>,
                    <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
<para>
</para>
<refsect3 role="returns">
<title>Returns</title>

<para/>
</refsect3></refsect2>
<refsect2 id="milter-agent-shutdown" role="function">
<title>milter_agent_shutdown ()</title>
<indexterm zone="milter-agent-shutdown"><primary>milter_agent_shutdown</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
milter_agent_shutdown (<parameter><link linkend="MilterAgent"><type>MilterAgent</type></link> *agent</parameter>);</programlisting>
<para>
</para>
</refsect2>

</refsect1>
<refsect1 id="milter-manager-milter-agent.other_details" role="details">
<title role="details.title">Types and Values</title>
<refsect2 id="MilterAgentError" role="enum">
<title>enum MilterAgentError</title>
<indexterm zone="MilterAgentError"><primary>MilterAgentError</primary></indexterm>
<para>
</para>
<refsect3 role="enum_members">
<title>Members</title>
<informaltable role="enum_members_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="enum_members_name" colwidth="300px"/>
<colspec colname="enum_members_description"/>
<colspec colname="enum_members_annotations" colwidth="200px"/>
<tbody>
<row role="constant"><entry role="enum_member_name"><para id="MILTER-AGENT-ERROR-IO-ERROR:CAPS">MILTER_AGENT_ERROR_IO_ERROR</para></entry>
<entry role="enum_member_description"/>
<entry role="enum_member_annotations"/>
</row>
<row role="constant"><entry role="enum_member_name"><para id="MILTER-AGENT-ERROR-DECODE-ERROR:CAPS">MILTER_AGENT_ERROR_DECODE_ERROR</para></entry>
<entry role="enum_member_description"/>
<entry role="enum_member_annotations"/>
</row>
<row role="constant"><entry role="enum_member_name"><para id="MILTER-AGENT-ERROR-NO-EVENT-LOOP-ERROR:CAPS">MILTER_AGENT_ERROR_NO_EVENT_LOOP_ERROR</para></entry>
<entry role="enum_member_description"/>
<entry role="enum_member_annotations"/>
</row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="MilterAgent-struct" role="struct">
<title>struct MilterAgent</title>
<indexterm zone="MilterAgent-struct"><primary>MilterAgent</primary></indexterm>
<programlisting language="C">struct MilterAgent;</programlisting>
<para>
</para>
</refsect2>

</refsect1>

</refentry>
