<refentry id="camel-CamelStreamFilter">
<refmeta>
<refentrytitle role="top_of_page" id="camel-CamelStreamFilter.top_of_page">CamelStreamFilter</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>CAMEL Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>CamelStreamFilter</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="camel-CamelStreamFilter.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
struct              <link linkend="CamelStreamFilter">CamelStreamFilter</link>;
<link linkend="CamelStreamFilter">CamelStreamFilter</link>*  <link linkend="camel-stream-filter-new-with-stream">camel_stream_filter_new_with_stream</link> (<link linkend="CamelStream">CamelStream</link> *stream);
<link linkend="int">int</link>                 <link linkend="camel-stream-filter-add">camel_stream_filter_add</link>             (<link linkend="CamelStreamFilter">CamelStreamFilter</link> *stream,
                                                         <link linkend="CamelMimeFilter">CamelMimeFilter</link> *filter);
<link linkend="void">void</link>                <link linkend="camel-stream-filter-remove">camel_stream_filter_remove</link>          (<link linkend="CamelStreamFilter">CamelStreamFilter</link> *stream,
                                                         <link linkend="int">int</link> id);
</synopsis>
</refsynopsisdiv>









<refsect1 id="camel-CamelStreamFilter.description" role="desc">
<title role="desc.title">Description</title>
<para>

</para>
</refsect1>

<refsect1 id="camel-CamelStreamFilter.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="CamelStreamFilter" role="struct">
<title>struct CamelStreamFilter</title>
<indexterm zone="CamelStreamFilter"><primary>CamelStreamFilter</primary></indexterm><programlisting>struct CamelStreamFilter {
	CamelStream parent;

	CamelStream *source;

	struct _CamelStreamFilterPrivate *priv;
};
</programlisting>
<para>

</para></refsect2>
<refsect2 id="camel-stream-filter-new-with-stream" role="function">
<title>camel_stream_filter_new_with_stream ()</title>
<indexterm zone="camel-stream-filter-new-with-stream"><primary>camel_stream_filter_new_with_stream</primary></indexterm><programlisting><link linkend="CamelStreamFilter">CamelStreamFilter</link>*  camel_stream_filter_new_with_stream (<link linkend="CamelStream">CamelStream</link> *stream);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>stream</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-stream-filter-add" role="function">
<title>camel_stream_filter_add ()</title>
<indexterm zone="camel-stream-filter-add"><primary>camel_stream_filter_add</primary></indexterm><programlisting><link linkend="int">int</link>                 camel_stream_filter_add             (<link linkend="CamelStreamFilter">CamelStreamFilter</link> *stream,
                                                         <link linkend="CamelMimeFilter">CamelMimeFilter</link> *filter);</programlisting>
<para>
Add a new <link linkend="CamelMimeFilter"><type>CamelMimeFilter</type></link> to execute during the processing of this
stream.  Each filter added is processed after the previous one.
</para>
<para>
Note that a filter should only be added to a single stream
at a time, otherwise unpredictable results may occur.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>stream</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="CamelStreamFilter"><type>CamelStreamFilter</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>filter</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="CamelMimeFilter"><type>CamelMimeFilter</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>a filter id for the added <parameter>filter</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-stream-filter-remove" role="function">
<title>camel_stream_filter_remove ()</title>
<indexterm zone="camel-stream-filter-remove"><primary>camel_stream_filter_remove</primary></indexterm><programlisting><link linkend="void">void</link>                camel_stream_filter_remove          (<link linkend="CamelStreamFilter">CamelStreamFilter</link> *stream,
                                                         <link linkend="int">int</link> id);</programlisting>
<para>
Remove a processing filter from the stream by id.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>stream</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="CamelStreamFilter"><type>CamelStreamFilter</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>id</parameter>&nbsp;:</term>
<listitem><simpara> Filter id, as returned from <link linkend="camel-stream-filter-add"><type>camel_stream_filter_add</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>
