4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>CamelDataWrapper</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
6
<meta name="generator" content="DocBook XSL Stylesheets V1.73.1">
7
7
<link rel="start" href="index.html" title="Camel Reference Manual">
8
8
<link rel="up" href="MIME.html" title="MIME Objects">
9
9
<link rel="prev" href="MIME.html" title="MIME Objects">
10
10
<link rel="next" href="camel-CamelMedium.html" title="CamelMedium">
11
<meta name="generator" content="GTK-Doc V1.9 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="part" href="classes.html" title="Part I. Camel Classes">
14
14
<link rel="chapter" href="ClassTree.html" title="Class hierarchy">
31
31
<th width="100%" align="center">Camel Reference Manual</th>
32
32
<td><a accesskey="n" href="camel-CamelMedium.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
34
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2705314" class="shortcut">Top</a>
34
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2734130" class="shortcut">Top</a>
36
<a href="#id2706273" class="shortcut">Description</a></nobr></td></tr>
36
<a href="#id2735088" class="shortcut">Description</a></nobr></td></tr>
38
38
<div class="refentry" lang="en">
39
39
<a name="camel-CamelDataWrapper"></a><div class="titlepage"></div>
40
40
<div class="refnamediv"><table width="100%"><tr>
43
<a name="id2705314"></a><span class="refentrytitle">CamelDataWrapper</span>
43
<a name="id2734130"></a><span class="refentrytitle">CamelDataWrapper</span>
45
45
<p>CamelDataWrapper</p>
55
struct <a href="camel-CamelDataWrapper.html#CamelDataWrapper">CamelDataWrapper</a>;
56
<a href="camel-CamelDataWrapper.html#CamelDataWrapper">CamelDataWrapper</a>* <a href="camel-CamelDataWrapper.html#camel-data-wrapper-new">camel_data_wrapper_new</a> (void);
57
ssize_t <a href="camel-CamelDataWrapper.html#camel-data-wrapper-write-to-stream">camel_data_wrapper_write_to_stream</a> (<a href="camel-CamelDataWrapper.html#CamelDataWrapper">CamelDataWrapper</a> *data_wrapper,
58
<a href="camel-CamelStream.html#CamelStream">CamelStream</a> *stream);
59
ssize_t <a href="camel-CamelDataWrapper.html#camel-data-wrapper-decode-to-stream">camel_data_wrapper_decode_to_stream</a> (<a href="camel-CamelDataWrapper.html#CamelDataWrapper">CamelDataWrapper</a> *data_wrapper,
60
<a href="camel-CamelStream.html#CamelStream">CamelStream</a> *stream);
61
void <a href="camel-CamelDataWrapper.html#camel-data-wrapper-set-mime-type">camel_data_wrapper_set_mime_type</a> (<a href="camel-CamelDataWrapper.html#CamelDataWrapper">CamelDataWrapper</a> *data_wrapper,
55
struct <a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper">CamelDataWrapper</a>;
56
<a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper">CamelDataWrapper</a>* <a class="link" href="camel-CamelDataWrapper.html#camel-data-wrapper-new">camel_data_wrapper_new</a> (void);
57
ssize_t <a class="link" href="camel-CamelDataWrapper.html#camel-data-wrapper-write-to-stream">camel_data_wrapper_write_to_stream</a> (<a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper">CamelDataWrapper</a> *data_wrapper,
58
<a class="link" href="camel-CamelStream.html#CamelStream">CamelStream</a> *stream);
59
ssize_t <a class="link" href="camel-CamelDataWrapper.html#camel-data-wrapper-decode-to-stream">camel_data_wrapper_decode_to_stream</a> (<a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper">CamelDataWrapper</a> *data_wrapper,
60
<a class="link" href="camel-CamelStream.html#CamelStream">CamelStream</a> *stream);
61
void <a class="link" href="camel-CamelDataWrapper.html#camel-data-wrapper-set-mime-type">camel_data_wrapper_set_mime_type</a> (<a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper">CamelDataWrapper</a> *data_wrapper,
62
62
const char *mime_type);
63
char* <a href="camel-CamelDataWrapper.html#camel-data-wrapper-get-mime-type">camel_data_wrapper_get_mime_type</a> (<a href="camel-CamelDataWrapper.html#CamelDataWrapper">CamelDataWrapper</a> *data_wrapper);
64
CamelContentType* <a href="camel-CamelDataWrapper.html#camel-data-wrapper-get-mime-type-field">camel_data_wrapper_get_mime_type_field</a>
65
(<a href="camel-CamelDataWrapper.html#CamelDataWrapper">CamelDataWrapper</a> *data_wrapper);
66
void <a href="camel-CamelDataWrapper.html#camel-data-wrapper-set-mime-type-field">camel_data_wrapper_set_mime_type_field</a>
67
(<a href="camel-CamelDataWrapper.html#CamelDataWrapper">CamelDataWrapper</a> *data_wrapper,
63
char* <a class="link" href="camel-CamelDataWrapper.html#camel-data-wrapper-get-mime-type">camel_data_wrapper_get_mime_type</a> (<a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper">CamelDataWrapper</a> *data_wrapper);
64
CamelContentType* <a class="link" href="camel-CamelDataWrapper.html#camel-data-wrapper-get-mime-type-field">camel_data_wrapper_get_mime_type_field</a>
65
(<a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper">CamelDataWrapper</a> *data_wrapper);
66
void <a class="link" href="camel-CamelDataWrapper.html#camel-data-wrapper-set-mime-type-field">camel_data_wrapper_set_mime_type_field</a>
67
(<a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper">CamelDataWrapper</a> *data_wrapper,
68
68
CamelContentType *mime_type);
69
int <a href="camel-CamelDataWrapper.html#camel-data-wrapper-construct-from-stream">camel_data_wrapper_construct_from_stream</a>
70
(<a href="camel-CamelDataWrapper.html#CamelDataWrapper">CamelDataWrapper</a> *data_wrapper,
71
<a href="camel-CamelStream.html#CamelStream">CamelStream</a> *stream);
73
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
74
>gboolean</a> <a href="camel-CamelDataWrapper.html#camel-data-wrapper-is-offline">camel_data_wrapper_is_offline</a> (<a href="camel-CamelDataWrapper.html#CamelDataWrapper">CamelDataWrapper</a> *data_wrapper);
69
int <a class="link" href="camel-CamelDataWrapper.html#camel-data-wrapper-construct-from-stream">camel_data_wrapper_construct_from_stream</a>
70
(<a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper">CamelDataWrapper</a> *data_wrapper,
71
<a class="link" href="camel-CamelStream.html#CamelStream">CamelStream</a> *stream);
72
gboolean <a class="link" href="camel-CamelDataWrapper.html#camel-data-wrapper-is-offline">camel_data_wrapper_is_offline</a> (<a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper">CamelDataWrapper</a> *data_wrapper);
79
77
<div class="refsect1" lang="en">
80
<a name="id2706273"></a><h2>Description</h2>
78
<a name="id2735088"></a><h2>Description</h2>
85
83
<div class="refsect1" lang="en">
86
<a name="id2706287"></a><h2>Details</h2>
84
<a name="id2735103"></a><h2>Details</h2>
87
85
<div class="refsect2" lang="en">
88
<a name="id2706297"></a><h3>
86
<a name="id2735113"></a><h3>
89
87
<a name="CamelDataWrapper"></a>struct CamelDataWrapper</h3>
90
<a class="indexterm" name="id2706311"></a><pre class="programlisting">struct CamelDataWrapper {
88
<a class="indexterm" name="id2735126"></a><pre class="programlisting">struct CamelDataWrapper {
91
89
CamelObject parent_object;
92
90
struct _CamelDataWrapperPrivate *priv;
107
105
<div class="refsect2" lang="en">
108
<a name="id2706329"></a><h3>
106
<a name="id2735144"></a><h3>
109
107
<a name="camel-data-wrapper-new"></a>camel_data_wrapper_new ()</h3>
110
<a class="indexterm" name="id2706342"></a><pre class="programlisting"><a href="camel-CamelDataWrapper.html#CamelDataWrapper">CamelDataWrapper</a>* camel_data_wrapper_new (void);</pre>
108
<a class="indexterm" name="id2735158"></a><pre class="programlisting"><a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper">CamelDataWrapper</a>* camel_data_wrapper_new (void);</pre>
112
Create a new <a href="camel-CamelDataWrapper.html#CamelDataWrapper"><span class="type">CamelDataWrapper</span></a> object.</p>
110
Create a new <a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper"><span class="type">CamelDataWrapper</span></a> object.</p>
116
114
<div class="variablelist"><table border="0">
117
115
<col align="left" valign="top">
119
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
120
<td>a new <a href="camel-CamelDataWrapper.html#CamelDataWrapper"><span class="type">CamelDataWrapper</span></a> object
117
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
118
<td>a new <a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper"><span class="type">CamelDataWrapper</span></a> object
126
124
<div class="refsect2" lang="en">
127
<a name="id2706399"></a><h3>
125
<a name="id2735215"></a><h3>
128
126
<a name="camel-data-wrapper-write-to-stream"></a>camel_data_wrapper_write_to_stream ()</h3>
129
<a class="indexterm" name="id2706414"></a><pre class="programlisting">ssize_t camel_data_wrapper_write_to_stream (<a href="camel-CamelDataWrapper.html#CamelDataWrapper">CamelDataWrapper</a> *data_wrapper,
130
<a href="camel-CamelStream.html#CamelStream">CamelStream</a> *stream);</pre>
127
<a class="indexterm" name="id2735229"></a><pre class="programlisting">ssize_t camel_data_wrapper_write_to_stream (<a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper">CamelDataWrapper</a> *data_wrapper,
128
<a class="link" href="camel-CamelStream.html#CamelStream">CamelStream</a> *stream);</pre>
132
130
Writes the content of <em class="parameter"><code>data_wrapper</code></em> to <em class="parameter"><code>stream</code></em> in a machine-independent
133
131
format appropriate for the data. It should be possible to construct an
134
132
equivalent data wrapper object later by passing this stream to
135
<a href="camel-CamelDataWrapper.html#camel-data-wrapper-construct-from-stream"><span class="type">camel_data_wrapper_construct_from_stream</span></a>.</p>
133
<a class="link" href="camel-CamelDataWrapper.html#camel-data-wrapper-construct-from-stream"><span class="type">camel_data_wrapper_construct_from_stream</span></a>.</p>
140
138
<col align="left" valign="top">
143
<td><span class="term"><em class="parameter"><code>data_wrapper</code></em> :</span></td>
144
<td> a <a href="camel-CamelDataWrapper.html#CamelDataWrapper"><span class="type">CamelDataWrapper</span></a> object
148
<td><span class="term"><em class="parameter"><code>stream</code></em> :</span></td>
149
<td> a <a href="camel-CamelStream.html#CamelStream"><span class="type">CamelStream</span></a> for output
153
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
141
<td><p><span class="term"><em class="parameter"><code>data_wrapper</code></em> :</span></p></td>
142
<td> a <a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper"><span class="type">CamelDataWrapper</span></a> object
146
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
147
<td> a <a class="link" href="camel-CamelStream.html#CamelStream"><span class="type">CamelStream</span></a> for output
151
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
154
152
<td>the number of bytes written, or <code class="literal">-1</code> on fail
161
159
<div class="refsect2" lang="en">
162
<a name="id2706546"></a><h3>
160
<a name="id2735362"></a><h3>
163
161
<a name="camel-data-wrapper-decode-to-stream"></a>camel_data_wrapper_decode_to_stream ()</h3>
164
<a class="indexterm" name="id2706561"></a><pre class="programlisting">ssize_t camel_data_wrapper_decode_to_stream (<a href="camel-CamelDataWrapper.html#CamelDataWrapper">CamelDataWrapper</a> *data_wrapper,
165
<a href="camel-CamelStream.html#CamelStream">CamelStream</a> *stream);</pre>
162
<a class="indexterm" name="id2735376"></a><pre class="programlisting">ssize_t camel_data_wrapper_decode_to_stream (<a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper">CamelDataWrapper</a> *data_wrapper,
163
<a class="link" href="camel-CamelStream.html#CamelStream">CamelStream</a> *stream);</pre>
167
165
Writes the decoded data content to <em class="parameter"><code>stream</code></em>.</p>
172
170
<col align="left" valign="top">
175
<td><span class="term"><em class="parameter"><code>data_wrapper</code></em> :</span></td>
176
<td> a <a href="camel-CamelDataWrapper.html#CamelDataWrapper"><span class="type">CamelDataWrapper</span></a> object
180
<td><span class="term"><em class="parameter"><code>stream</code></em> :</span></td>
181
<td> a <a href="camel-CamelStream.html#CamelStream"><span class="type">CamelStream</span></a> for decoded data to be written to
185
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
173
<td><p><span class="term"><em class="parameter"><code>data_wrapper</code></em> :</span></p></td>
174
<td> a <a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper"><span class="type">CamelDataWrapper</span></a> object
178
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
179
<td> a <a class="link" href="camel-CamelStream.html#CamelStream"><span class="type">CamelStream</span></a> for decoded data to be written to
183
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
186
184
<td>the number of bytes written, or <code class="literal">-1</code> on fail
193
191
<div class="refsect2" lang="en">
194
<a name="id2706676"></a><h3>
192
<a name="id2735491"></a><h3>
195
193
<a name="camel-data-wrapper-set-mime-type"></a>camel_data_wrapper_set_mime_type ()</h3>
196
<a class="indexterm" name="id2706689"></a><pre class="programlisting">void camel_data_wrapper_set_mime_type (<a href="camel-CamelDataWrapper.html#CamelDataWrapper">CamelDataWrapper</a> *data_wrapper,
194
<a class="indexterm" name="id2735505"></a><pre class="programlisting">void camel_data_wrapper_set_mime_type (<a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper">CamelDataWrapper</a> *data_wrapper,
197
195
const char *mime_type);</pre>
199
197
This sets the data wrapper's MIME type.
280
278
<div class="refsect2" lang="en">
281
<a name="id2706947"></a><h3>
279
<a name="id2735763"></a><h3>
282
280
<a name="camel-data-wrapper-set-mime-type-field"></a>camel_data_wrapper_set_mime_type_field ()</h3>
283
<a class="indexterm" name="id2706962"></a><pre class="programlisting">void camel_data_wrapper_set_mime_type_field
284
(<a href="camel-CamelDataWrapper.html#CamelDataWrapper">CamelDataWrapper</a> *data_wrapper,
281
<a class="indexterm" name="id2735777"></a><pre class="programlisting">void camel_data_wrapper_set_mime_type_field
282
(<a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper">CamelDataWrapper</a> *data_wrapper,
285
283
CamelContentType *mime_type);</pre>
287
285
This sets the data wrapper's MIME type. It suffers from the same
288
flaws as <a href="camel-CamelDataWrapper.html#camel-data-wrapper-set-mime-type"><span class="type">camel_data_wrapper_set_mime_type</span></a>.</p>
286
flaws as <a class="link" href="camel-CamelDataWrapper.html#camel-data-wrapper-set-mime-type"><span class="type">camel_data_wrapper_set_mime_type</span></a>.</p>
309
307
<div class="refsect2" lang="en">
310
<a name="id2707062"></a><h3>
308
<a name="id2735877"></a><h3>
311
309
<a name="camel-data-wrapper-construct-from-stream"></a>camel_data_wrapper_construct_from_stream ()</h3>
312
<a class="indexterm" name="id2707076"></a><pre class="programlisting">int camel_data_wrapper_construct_from_stream
313
(<a href="camel-CamelDataWrapper.html#CamelDataWrapper">CamelDataWrapper</a> *data_wrapper,
314
<a href="camel-CamelStream.html#CamelStream">CamelStream</a> *stream);</pre>
310
<a class="indexterm" name="id2735891"></a><pre class="programlisting">int camel_data_wrapper_construct_from_stream
311
(<a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper">CamelDataWrapper</a> *data_wrapper,
312
<a class="link" href="camel-CamelStream.html#CamelStream">CamelStream</a> *stream);</pre>
316
314
Constructs the content of <em class="parameter"><code>data_wrapper</code></em> from the supplied <em class="parameter"><code>stream</code></em>.</p>
321
319
<col align="left" valign="top">
324
<td><span class="term"><em class="parameter"><code>data_wrapper</code></em> :</span></td>
325
<td> a <a href="camel-CamelDataWrapper.html#CamelDataWrapper"><span class="type">CamelDataWrapper</span></a> object
329
<td><span class="term"><em class="parameter"><code>stream</code></em> :</span></td>
330
<td> an input <a href="camel-CamelStream.html#CamelStream"><span class="type">CamelStream</span></a>
334
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
322
<td><p><span class="term"><em class="parameter"><code>data_wrapper</code></em> :</span></p></td>
323
<td> a <a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper"><span class="type">CamelDataWrapper</span></a> object
327
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
328
<td> an input <a class="link" href="camel-CamelStream.html#CamelStream"><span class="type">CamelStream</span></a>
332
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
336
334
<code class="literal">0</code> on success or <code class="literal">-1</code> on fail
355
351
<col align="left" valign="top">
358
<td><span class="term"><em class="parameter"><code>data_wrapper</code></em> :</span></td>
359
<td> a <a href="camel-CamelDataWrapper.html#CamelDataWrapper"><span class="type">CamelDataWrapper</span></a> object
354
<td><p><span class="term"><em class="parameter"><code>data_wrapper</code></em> :</span></p></td>
355
<td> a <a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper"><span class="type">CamelDataWrapper</span></a> object
363
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
359
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
364
360
<td>whether <em class="parameter"><code>data_wrapper</code></em> is "offline" (data stored
365
361
remotely) or not. Some optional code paths may choose to not
366
362
operate on offline data.