File: camel-CamelStreamFilter.html

package info (click to toggle)
evolution-data-server 2.30.3-2%2Bsqueeze1
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 45,704 kB
  • ctags: 26,968
  • sloc: ansic: 223,692; sh: 10,413; makefile: 2,646; xml: 386; perl: 204; python: 30
file content (154 lines) | stat: -rw-r--r-- 8,893 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CamelStreamFilter</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="Camel Reference Manual">
<link rel="up" href="Streams.html" title="Streams">
<link rel="prev" href="camel-CamelStreamBuffer.html" title="CamelStreamBuffer">
<link rel="next" href="camel-CamelStreamFs.html" title="CamelStreamFs">
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="camel-CamelStreamBuffer.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="Streams.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Camel Reference Manual</th>
<td><a accesskey="n" href="camel-CamelStreamFs.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#camel-CamelStreamFilter.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#camel-CamelStreamFilter.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="CamelStreamFilter">
<a name="camel-CamelStreamFilter"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="camel-CamelStreamFilter.top_of_page"></a>CamelStreamFilter</span></h2>
<p>CamelStreamFilter</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="camel-CamelStreamFilter.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct              <a class="link" href="camel-CamelStreamFilter.html#CamelStreamFilter" title="struct CamelStreamFilter">CamelStreamFilter</a>;
<a class="link" href="camel-CamelStreamFilter.html#CamelStreamFilter" title="struct CamelStreamFilter"><span class="returnvalue">CamelStreamFilter</span></a> * <a class="link" href="camel-CamelStreamFilter.html#camel-stream-filter-new-with-stream" title="camel_stream_filter_new_with_stream ()">camel_stream_filter_new_with_stream</a> (<em class="parameter"><code><a class="link" href="camel-CamelStream.html#CamelStream" title="struct CamelStream"><span class="type">CamelStream</span></a> *stream</code></em>);
<span class="returnvalue">gint</span>                <a class="link" href="camel-CamelStreamFilter.html#camel-stream-filter-add" title="camel_stream_filter_add ()">camel_stream_filter_add</a>             (<em class="parameter"><code><a class="link" href="camel-CamelStreamFilter.html#CamelStreamFilter" title="struct CamelStreamFilter"><span class="type">CamelStreamFilter</span></a> *stream</code></em>,
                                                         <em class="parameter"><code><a class="link" href="camel-CamelMimeFilter.html#CamelMimeFilter" title="struct CamelMimeFilter"><span class="type">CamelMimeFilter</span></a> *filter</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="camel-CamelStreamFilter.html#camel-stream-filter-remove" title="camel_stream_filter_remove ()">camel_stream_filter_remove</a>          (<em class="parameter"><code><a class="link" href="camel-CamelStreamFilter.html#CamelStreamFilter" title="struct CamelStreamFilter"><span class="type">CamelStreamFilter</span></a> *stream</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> id</code></em>);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="camel-CamelStreamFilter.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="camel-CamelStreamFilter.details"></a><h2>Details</h2>
<div class="refsect2" title="struct CamelStreamFilter">
<a name="CamelStreamFilter"></a><h3>struct CamelStreamFilter</h3>
<pre class="programlisting">struct CamelStreamFilter {
	CamelStream parent;

	CamelStream *source;

	struct _CamelStreamFilterPrivate *priv;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="camel_stream_filter_new_with_stream ()">
<a name="camel-stream-filter-new-with-stream"></a><h3>camel_stream_filter_new_with_stream ()</h3>
<pre class="programlisting"><a class="link" href="camel-CamelStreamFilter.html#CamelStreamFilter" title="struct CamelStreamFilter"><span class="returnvalue">CamelStreamFilter</span></a> * camel_stream_filter_new_with_stream (<em class="parameter"><code><a class="link" href="camel-CamelStream.html#CamelStream" title="struct CamelStream"><span class="type">CamelStream</span></a> *stream</code></em>);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_stream_filter_add ()">
<a name="camel-stream-filter-add"></a><h3>camel_stream_filter_add ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>                camel_stream_filter_add             (<em class="parameter"><code><a class="link" href="camel-CamelStreamFilter.html#CamelStreamFilter" title="struct CamelStreamFilter"><span class="type">CamelStreamFilter</span></a> *stream</code></em>,
                                                         <em class="parameter"><code><a class="link" href="camel-CamelMimeFilter.html#CamelMimeFilter" title="struct CamelMimeFilter"><span class="type">CamelMimeFilter</span></a> *filter</code></em>);</pre>
<p>
Add a new <a class="link" href="camel-CamelMimeFilter.html#CamelMimeFilter" title="struct CamelMimeFilter"><span class="type">CamelMimeFilter</span></a> to execute during the processing of this
stream.  Each filter added is processed after the previous one.
</p>
<p>
Note that a filter should only be added to a single stream
at a time, otherwise unpredictable results may occur.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
<td>a <a class="link" href="camel-CamelStreamFilter.html#CamelStreamFilter" title="struct CamelStreamFilter"><span class="type">CamelStreamFilter</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td>
<td>a <a class="link" href="camel-CamelMimeFilter.html#CamelMimeFilter" title="struct CamelMimeFilter"><span class="type">CamelMimeFilter</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a filter id for the added <em class="parameter"><code>filter</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_stream_filter_remove ()">
<a name="camel-stream-filter-remove"></a><h3>camel_stream_filter_remove ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                camel_stream_filter_remove          (<em class="parameter"><code><a class="link" href="camel-CamelStreamFilter.html#CamelStreamFilter" title="struct CamelStreamFilter"><span class="type">CamelStreamFilter</span></a> *stream</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> id</code></em>);</pre>
<p>
Remove a processing filter from the stream by id.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
<td>a <a class="link" href="camel-CamelStreamFilter.html#CamelStreamFilter" title="struct CamelStreamFilter"><span class="type">CamelStreamFilter</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
<td>Filter id, as returned from <a class="link" href="camel-CamelStreamFilter.html#camel-stream-filter-add" title="camel_stream_filter_add ()"><span class="type">camel_stream_filter_add</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.14</div>
</body>
</html>