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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
|
<refentry id="camel-CamelMedium">
<refmeta>
<refentrytitle role="top_of_page" id="camel-CamelMedium.top_of_page">CamelMedium</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>CAMEL Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>CamelMedium</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="camel-CamelMedium.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
struct <link linkend="CamelMedium">CamelMedium</link>;
<link linkend="CamelMediumHeader">CamelMediumHeader</link>;
<link linkend="void">void</link> <link linkend="camel-medium-add-header">camel_medium_add_header</link> (<link linkend="CamelMedium">CamelMedium</link> *medium,
const <link linkend="char">char</link> *name,
const <link linkend="void">void</link> *value);
<link linkend="void">void</link> <link linkend="camel-medium-set-header">camel_medium_set_header</link> (<link linkend="CamelMedium">CamelMedium</link> *medium,
const <link linkend="char">char</link> *name,
const <link linkend="void">void</link> *value);
<link linkend="void">void</link> <link linkend="camel-medium-remove-header">camel_medium_remove_header</link> (<link linkend="CamelMedium">CamelMedium</link> *medium,
const <link linkend="char">char</link> *name);
const <link linkend="void">void</link>* <link linkend="camel-medium-get-header">camel_medium_get_header</link> (<link linkend="CamelMedium">CamelMedium</link> *medium,
const <link linkend="char">char</link> *name);
<link linkend="GArray">GArray</link>* <link linkend="camel-medium-get-headers">camel_medium_get_headers</link> (<link linkend="CamelMedium">CamelMedium</link> *medium);
<link linkend="void">void</link> <link linkend="camel-medium-free-headers">camel_medium_free_headers</link> (<link linkend="CamelMedium">CamelMedium</link> *medium,
<link linkend="GArray">GArray</link> *headers);
<link linkend="CamelDataWrapper">CamelDataWrapper</link>* <link linkend="camel-medium-get-content-object">camel_medium_get_content_object</link> (<link linkend="CamelMedium">CamelMedium</link> *medium);
<link linkend="void">void</link> <link linkend="camel-medium-set-content-object">camel_medium_set_content_object</link> (<link linkend="CamelMedium">CamelMedium</link> *medium,
<link linkend="CamelDataWrapper">CamelDataWrapper</link> *content);
</synopsis>
</refsynopsisdiv>
<refsect1 id="camel-CamelMedium.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="camel-CamelMedium.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="CamelMedium" role="struct">
<title>struct CamelMedium</title>
<indexterm zone="CamelMedium"><primary>CamelMedium</primary></indexterm><programlisting>struct CamelMedium {
CamelDataWrapper parent_object;
/* The content of the medium, as opposed to our parent
* CamelDataWrapper, which wraps both the headers and the
* content.
*/
CamelDataWrapper *content;
};
</programlisting>
<para>
</para></refsect2>
<refsect2 id="CamelMediumHeader" role="struct">
<title>CamelMediumHeader</title>
<indexterm zone="CamelMediumHeader"><primary>CamelMediumHeader</primary></indexterm><programlisting>typedef struct {
const char *name;
const char *value;
} CamelMediumHeader;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="camel-medium-add-header" role="function">
<title>camel_medium_add_header ()</title>
<indexterm zone="camel-medium-add-header"><primary>camel_medium_add_header</primary></indexterm><programlisting><link linkend="void">void</link> camel_medium_add_header (<link linkend="CamelMedium">CamelMedium</link> *medium,
const <link linkend="char">char</link> *name,
const <link linkend="void">void</link> *value);</programlisting>
<para>
Adds a header to a <link linkend="CamelMedium"><type>CamelMedium</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>medium</parameter> :</term>
<listitem><simpara> a <link linkend="CamelMedium"><type>CamelMedium</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> name of the header
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> value of the header
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-medium-set-header" role="function">
<title>camel_medium_set_header ()</title>
<indexterm zone="camel-medium-set-header"><primary>camel_medium_set_header</primary></indexterm><programlisting><link linkend="void">void</link> camel_medium_set_header (<link linkend="CamelMedium">CamelMedium</link> *medium,
const <link linkend="char">char</link> *name,
const <link linkend="void">void</link> *value);</programlisting>
<para>
Sets the value of a header. Any other occurances of the header
will be removed. Setting a <link linkend="NULL:CAPS"><literal>NULL</literal></link> header can be used to remove
the header also.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>medium</parameter> :</term>
<listitem><simpara> a <link linkend="CamelMedium"><type>CamelMedium</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> name of the header
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> value of the header
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-medium-remove-header" role="function">
<title>camel_medium_remove_header ()</title>
<indexterm zone="camel-medium-remove-header"><primary>camel_medium_remove_header</primary></indexterm><programlisting><link linkend="void">void</link> camel_medium_remove_header (<link linkend="CamelMedium">CamelMedium</link> *medium,
const <link linkend="char">char</link> *name);</programlisting>
<para>
Removes the named header from the medium. All occurances of the
header are removed.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>medium</parameter> :</term>
<listitem><simpara> a <link linkend="CamelMedium"><type>CamelMedium</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> the name of the header
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-medium-get-header" role="function">
<title>camel_medium_get_header ()</title>
<indexterm zone="camel-medium-get-header"><primary>camel_medium_get_header</primary></indexterm><programlisting>const <link linkend="void">void</link>* camel_medium_get_header (<link linkend="CamelMedium">CamelMedium</link> *medium,
const <link linkend="char">char</link> *name);</programlisting>
<para>
Gets the value of the named header in the medium, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if
it is unset. The caller should not modify or free the data.
</para>
<para>
If the header occurs more than once, only retrieve the first
instance of the header. For multi-occuring headers, use
:<link linkend="get-headers"><function>get_headers()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>medium</parameter> :</term>
<listitem><simpara> a <link linkend="CamelMedium"><type>CamelMedium</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> the name of the header
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the value of the named header, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-medium-get-headers" role="function">
<title>camel_medium_get_headers ()</title>
<indexterm zone="camel-medium-get-headers"><primary>camel_medium_get_headers</primary></indexterm><programlisting><link linkend="GArray">GArray</link>* camel_medium_get_headers (<link linkend="CamelMedium">CamelMedium</link> *medium);</programlisting>
<para>
Gets an array of all header name/value pairs (as
CamelMediumHeader structures). The values will be decoded
to UTF-8 for any headers that are recognized by Camel. The
caller should not modify the returned data.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>medium</parameter> :</term>
<listitem><simpara> a <link linkend="CamelMedium"><type>CamelMedium</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the array of headers, which must be freed with
<link linkend="camel-medium-free-headers"><type>camel_medium_free_headers</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-medium-free-headers" role="function">
<title>camel_medium_free_headers ()</title>
<indexterm zone="camel-medium-free-headers"><primary>camel_medium_free_headers</primary></indexterm><programlisting><link linkend="void">void</link> camel_medium_free_headers (<link linkend="CamelMedium">CamelMedium</link> *medium,
<link linkend="GArray">GArray</link> *headers);</programlisting>
<para>
Frees <parameter>headers</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>medium</parameter> :</term>
<listitem><simpara> a <link linkend="CamelMedium"><type>CamelMedium</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>headers</parameter> :</term>
<listitem><simpara> an array of headers returned from <link linkend="camel-medium-get-headers"><type>camel_medium_get_headers</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-medium-get-content-object" role="function">
<title>camel_medium_get_content_object ()</title>
<indexterm zone="camel-medium-get-content-object"><primary>camel_medium_get_content_object</primary></indexterm><programlisting><link linkend="CamelDataWrapper">CamelDataWrapper</link>* camel_medium_get_content_object (<link linkend="CamelMedium">CamelMedium</link> *medium);</programlisting>
<para>
Getss a data wrapper that represents the content of the medium,
without its headers.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>medium</parameter> :</term>
<listitem><simpara> a <link linkend="CamelMedium"><type>CamelMedium</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>a <link linkend="CamelDataWrapper"><type>CamelDataWrapper</type></link> containing <parameter>medium</parameter>'s content
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-medium-set-content-object" role="function">
<title>camel_medium_set_content_object ()</title>
<indexterm zone="camel-medium-set-content-object"><primary>camel_medium_set_content_object</primary></indexterm><programlisting><link linkend="void">void</link> camel_medium_set_content_object (<link linkend="CamelMedium">CamelMedium</link> *medium,
<link linkend="CamelDataWrapper">CamelDataWrapper</link> *content);</programlisting>
<para>
Sets the content of <parameter>medium</parameter> to be <parameter>content</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>medium</parameter> :</term>
<listitem><simpara> a <link linkend="CamelMedium"><type>CamelMedium</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>content</parameter> :</term>
<listitem><simpara> a <link linkend="CamelDataWrapper"><type>CamelDataWrapper</type></link> object
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
