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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CamelService</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="Services.html" title="Services">
<link rel="prev" href="camel-camel-provider.html" title="camel-provider">
<link rel="next" href="camel-CamelStore.html" title="CamelStore">
<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-camel-provider.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="Services.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-CamelStore.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-CamelService.synopsis" class="shortcut">Top</a>
|
<a href="#camel-CamelService.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="CamelService">
<a name="camel-CamelService"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="camel-CamelService.top_of_page"></a>CamelService</span></h2>
<p>CamelService</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="camel-CamelService.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="camel-CamelService.html#CamelService" title="struct CamelService">CamelService</a>;
#define <a class="link" href="camel-CamelService.html#CAMEL-SERVICE-USERNAME:CAPS" title="CAMEL_SERVICE_USERNAME">CAMEL_SERVICE_USERNAME</a>
#define <a class="link" href="camel-CamelService.html#CAMEL-SERVICE-AUTH:CAPS" title="CAMEL_SERVICE_AUTH">CAMEL_SERVICE_AUTH</a>
#define <a class="link" href="camel-CamelService.html#CAMEL-SERVICE-HOSTNAME:CAPS" title="CAMEL_SERVICE_HOSTNAME">CAMEL_SERVICE_HOSTNAME</a>
#define <a class="link" href="camel-CamelService.html#CAMEL-SERVICE-PORT:CAPS" title="CAMEL_SERVICE_PORT">CAMEL_SERVICE_PORT</a>
#define <a class="link" href="camel-CamelService.html#CAMEL-SERVICE-PATH:CAPS" title="CAMEL_SERVICE_PATH">CAMEL_SERVICE_PATH</a>
enum <a class="link" href="camel-CamelService.html#CamelServiceConnectionStatus" title="enum CamelServiceConnectionStatus">CamelServiceConnectionStatus</a>;
<a class="link" href="camel-CamelService.html#CamelServiceAuthType" title="CamelServiceAuthType">CamelServiceAuthType</a>;
<span class="returnvalue">void</span> <a class="link" href="camel-CamelService.html#camel-service-construct" title="camel_service_construct ()">camel_service_construct</a> (<em class="parameter"><code><a class="link" href="camel-CamelService.html#CamelService" title="struct CamelService"><span class="type">CamelService</span></a> *service</code></em>,
<em class="parameter"><code><a class="link" href="camel-CamelSession.html#CamelSession" title="struct CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code><a class="link" href="camel-camel-provider.html#CamelProvider" title="CamelProvider"><span class="type">CamelProvider</span></a> *provider</code></em>,
<em class="parameter"><code><a class="link" href="camel-camel-url.html#CamelURL" title="CamelURL"><span class="type">CamelURL</span></a> *url</code></em>,
<em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="camel-CamelService.html#camel-service-connect" title="camel_service_connect ()">camel_service_connect</a> (<em class="parameter"><code><a class="link" href="camel-CamelService.html#CamelService" title="struct CamelService"><span class="type">CamelService</span></a> *service</code></em>,
<em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="camel-CamelService.html#camel-service-disconnect" title="camel_service_disconnect ()">camel_service_disconnect</a> (<em class="parameter"><code><a class="link" href="camel-CamelService.html#CamelService" title="struct CamelService"><span class="type">CamelService</span></a> *service</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> clean</code></em>,
<em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>);
<span class="returnvalue">void</span> <a class="link" href="camel-CamelService.html#camel-service-cancel-connect" title="camel_service_cancel_connect ()">camel_service_cancel_connect</a> (<em class="parameter"><code><a class="link" href="camel-CamelService.html#CamelService" title="struct CamelService"><span class="type">CamelService</span></a> *service</code></em>);
<span class="returnvalue">gchar</span> * <a class="link" href="camel-CamelService.html#camel-service-get-url" title="camel_service_get_url ()">camel_service_get_url</a> (<em class="parameter"><code><a class="link" href="camel-CamelService.html#CamelService" title="struct CamelService"><span class="type">CamelService</span></a> *service</code></em>);
<span class="returnvalue">gchar</span> * <a class="link" href="camel-CamelService.html#camel-service-get-name" title="camel_service_get_name ()">camel_service_get_name</a> (<em class="parameter"><code><a class="link" href="camel-CamelService.html#CamelService" title="struct CamelService"><span class="type">CamelService</span></a> *service</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> brief</code></em>);
<span class="returnvalue">gchar</span> * <a class="link" href="camel-CamelService.html#camel-service-get-path" title="camel_service_get_path ()">camel_service_get_path</a> (<em class="parameter"><code><a class="link" href="camel-CamelService.html#CamelService" title="struct CamelService"><span class="type">CamelService</span></a> *service</code></em>);
<a class="link" href="camel-CamelSession.html#CamelSession" title="struct CamelSession"><span class="returnvalue">CamelSession</span></a> * <a class="link" href="camel-CamelService.html#camel-service-get-session" title="camel_service_get_session ()">camel_service_get_session</a> (<em class="parameter"><code><a class="link" href="camel-CamelService.html#CamelService" title="struct CamelService"><span class="type">CamelService</span></a> *service</code></em>);
<a class="link" href="camel-camel-provider.html#CamelProvider" title="CamelProvider"><span class="returnvalue">CamelProvider</span></a> * <a class="link" href="camel-CamelService.html#camel-service-get-provider" title="camel_service_get_provider ()">camel_service_get_provider</a> (<em class="parameter"><code><a class="link" href="camel-CamelService.html#CamelService" title="struct CamelService"><span class="type">CamelService</span></a> *service</code></em>);
<span class="returnvalue">GList</span> * <a class="link" href="camel-CamelService.html#camel-service-query-auth-types" title="camel_service_query_auth_types ()">camel_service_query_auth_types</a> (<em class="parameter"><code><a class="link" href="camel-CamelService.html#CamelService" title="struct CamelService"><span class="type">CamelService</span></a> *service</code></em>,
<em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="camel-CamelService.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="camel-CamelService.details"></a><h2>Details</h2>
<div class="refsect2" title="struct CamelService">
<a name="CamelService"></a><h3>struct CamelService</h3>
<pre class="programlisting">struct CamelService {
CamelObject parent_object;
struct _CamelServicePrivate *priv;
CamelSession *session;
CamelProvider *provider;
CamelServiceConnectionStatus status;
CamelOperation *connect_op;
CamelURL *url;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="CAMEL_SERVICE_USERNAME">
<a name="CAMEL-SERVICE-USERNAME:CAPS"></a><h3>CAMEL_SERVICE_USERNAME</h3>
<pre class="programlisting">#define CAMEL_SERVICE_USERNAME (CAMEL_SERVICE_ARG_USERNAME | CAMEL_ARG_STR)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="CAMEL_SERVICE_AUTH">
<a name="CAMEL-SERVICE-AUTH:CAPS"></a><h3>CAMEL_SERVICE_AUTH</h3>
<pre class="programlisting">#define CAMEL_SERVICE_AUTH (CAMEL_SERVICE_ARG_AUTH | CAMEL_ARG_STR)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="CAMEL_SERVICE_HOSTNAME">
<a name="CAMEL-SERVICE-HOSTNAME:CAPS"></a><h3>CAMEL_SERVICE_HOSTNAME</h3>
<pre class="programlisting">#define CAMEL_SERVICE_HOSTNAME (CAMEL_SERVICE_ARG_HOSTNAME | CAMEL_ARG_STR)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="CAMEL_SERVICE_PORT">
<a name="CAMEL-SERVICE-PORT:CAPS"></a><h3>CAMEL_SERVICE_PORT</h3>
<pre class="programlisting">#define CAMEL_SERVICE_PORT (CAMEL_SERVICE_ARG_PORT | CAMEL_ARG_INT)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="CAMEL_SERVICE_PATH">
<a name="CAMEL-SERVICE-PATH:CAPS"></a><h3>CAMEL_SERVICE_PATH</h3>
<pre class="programlisting">#define CAMEL_SERVICE_PATH (CAMEL_SERVICE_ARG_PATH | CAMEL_ARG_STR)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="enum CamelServiceConnectionStatus">
<a name="CamelServiceConnectionStatus"></a><h3>enum CamelServiceConnectionStatus</h3>
<pre class="programlisting">typedef enum {
CAMEL_SERVICE_DISCONNECTED,
CAMEL_SERVICE_CONNECTING,
CAMEL_SERVICE_CONNECTED,
CAMEL_SERVICE_DISCONNECTING
} CamelServiceConnectionStatus;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="CamelServiceAuthType">
<a name="CamelServiceAuthType"></a><h3>CamelServiceAuthType</h3>
<pre class="programlisting">typedef struct {
const gchar *name; /* user-friendly name */
const gchar *description;
const gchar *authproto;
gboolean need_password; /* needs a password to authenticate */
} CamelServiceAuthType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="camel_service_construct ()">
<a name="camel-service-construct"></a><h3>camel_service_construct ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_service_construct (<em class="parameter"><code><a class="link" href="camel-CamelService.html#CamelService" title="struct CamelService"><span class="type">CamelService</span></a> *service</code></em>,
<em class="parameter"><code><a class="link" href="camel-CamelSession.html#CamelSession" title="struct CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code><a class="link" href="camel-camel-provider.html#CamelProvider" title="CamelProvider"><span class="type">CamelProvider</span></a> *provider</code></em>,
<em class="parameter"><code><a class="link" href="camel-camel-url.html#CamelURL" title="CamelURL"><span class="type">CamelURL</span></a> *url</code></em>,
<em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>);</pre>
<p>
Constructs a <a class="link" href="camel-CamelService.html#CamelService" title="struct CamelService"><span class="type">CamelService</span></a> initialized with the given parameters.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
<td>a <a class="link" href="camel-CamelService.html#CamelService" title="struct CamelService"><span class="type">CamelService</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>the <a class="link" href="camel-CamelSession.html#CamelSession" title="struct CamelSession"><span class="type">CamelSession</span></a> for <em class="parameter"><code>service</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
<td>the <a class="link" href="camel-camel-provider.html#CamelProvider" title="CamelProvider"><span class="type">CamelProvider</span></a> associated with <em class="parameter"><code>service</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>url</code></em> :</span></p></td>
<td>the default URL for the service (may be <code class="literal">NULL</code>)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ex</code></em> :</span></p></td>
<td>a <a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_service_connect ()">
<a name="camel-service-connect"></a><h3>camel_service_connect ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> camel_service_connect (<em class="parameter"><code><a class="link" href="camel-CamelService.html#CamelService" title="struct CamelService"><span class="type">CamelService</span></a> *service</code></em>,
<em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>);</pre>
<p>
Connect to the service using the parameters it was initialized
with.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
<td>a <a class="link" href="camel-CamelService.html#CamelService" title="struct CamelService"><span class="type">CamelService</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ex</code></em> :</span></p></td>
<td>a <a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">TRUE</code> if the connection is made or <code class="literal">FALSE</code> otherwise
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_service_disconnect ()">
<a name="camel-service-disconnect"></a><h3>camel_service_disconnect ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> camel_service_disconnect (<em class="parameter"><code><a class="link" href="camel-CamelService.html#CamelService" title="struct CamelService"><span class="type">CamelService</span></a> *service</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> clean</code></em>,
<em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>);</pre>
<p>
Disconnect from the service. If <em class="parameter"><code>clean</code></em> is <code class="literal">FALSE</code>, it should not
try to do any synchronizing or other cleanup of the connection.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
<td>a <a class="link" href="camel-CamelService.html#CamelService" title="struct CamelService"><span class="type">CamelService</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>clean</code></em> :</span></p></td>
<td>whether or not to try to disconnect cleanly
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ex</code></em> :</span></p></td>
<td>a <a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">TRUE</code> if the disconnect was successful or <code class="literal">FALSE</code> otherwise
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_service_cancel_connect ()">
<a name="camel-service-cancel-connect"></a><h3>camel_service_cancel_connect ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_service_cancel_connect (<em class="parameter"><code><a class="link" href="camel-CamelService.html#CamelService" title="struct CamelService"><span class="type">CamelService</span></a> *service</code></em>);</pre>
<p>
If <em class="parameter"><code>service</code></em> is currently attempting to connect to or disconnect
from a server, this causes it to stop and fail. Otherwise it is a
no-op.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
<td>a <a class="link" href="camel-CamelService.html#CamelService" title="struct CamelService"><span class="type">CamelService</span></a> object
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_service_get_url ()">
<a name="camel-service-get-url"></a><h3>camel_service_get_url ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> * camel_service_get_url (<em class="parameter"><code><a class="link" href="camel-CamelService.html#CamelService" title="struct CamelService"><span class="type">CamelService</span></a> *service</code></em>);</pre>
<p>
Gets the URL representing <em class="parameter"><code>service</code></em>. The returned URL must be
freed when it is no longer needed. For security reasons, this
routine does not return the password.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
<td>a <a class="link" href="camel-CamelService.html#CamelService" title="struct CamelService"><span class="type">CamelService</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the URL representing <em class="parameter"><code>service</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_service_get_name ()">
<a name="camel-service-get-name"></a><h3>camel_service_get_name ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> * camel_service_get_name (<em class="parameter"><code><a class="link" href="camel-CamelService.html#CamelService" title="struct CamelService"><span class="type">CamelService</span></a> *service</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> brief</code></em>);</pre>
<p>
This gets the name of the service in a "friendly" (suitable for
humans) form. If <em class="parameter"><code>brief</code></em> is <code class="literal">TRUE</code>, this should be a brief description
such as for use in the folder tree. If <em class="parameter"><code>brief</code></em> is <code class="literal">FALSE</code>, it should
be a more complete and mostly unambiguous description.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
<td>a <a class="link" href="camel-CamelService.html#CamelService" title="struct CamelService"><span class="type">CamelService</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>brief</code></em> :</span></p></td>
<td>whether or not to use a briefer form
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a description of the service which the caller must free
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_service_get_path ()">
<a name="camel-service-get-path"></a><h3>camel_service_get_path ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> * camel_service_get_path (<em class="parameter"><code><a class="link" href="camel-CamelService.html#CamelService" title="struct CamelService"><span class="type">CamelService</span></a> *service</code></em>);</pre>
<p>
This gets a valid UNIX relative path describing <em class="parameter"><code>service</code></em>, which
is guaranteed to be different from the path returned for any
different service. This path MUST start with the name of the
provider, followed by a "/", but after that, it is up to the
provider.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
<td>a <a class="link" href="camel-CamelService.html#CamelService" title="struct CamelService"><span class="type">CamelService</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the path, which the caller must free
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_service_get_session ()">
<a name="camel-service-get-session"></a><h3>camel_service_get_session ()</h3>
<pre class="programlisting"><a class="link" href="camel-CamelSession.html#CamelSession" title="struct CamelSession"><span class="returnvalue">CamelSession</span></a> * camel_service_get_session (<em class="parameter"><code><a class="link" href="camel-CamelService.html#CamelService" title="struct CamelService"><span class="type">CamelService</span></a> *service</code></em>);</pre>
<p>
Gets the <a class="link" href="camel-CamelSession.html#CamelSession" title="struct CamelSession"><span class="type">CamelSession</span></a> associated with the service.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
<td>a <a class="link" href="camel-CamelService.html#CamelService" title="struct CamelService"><span class="type">CamelService</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the session
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_service_get_provider ()">
<a name="camel-service-get-provider"></a><h3>camel_service_get_provider ()</h3>
<pre class="programlisting"><a class="link" href="camel-camel-provider.html#CamelProvider" title="CamelProvider"><span class="returnvalue">CamelProvider</span></a> * camel_service_get_provider (<em class="parameter"><code><a class="link" href="camel-CamelService.html#CamelService" title="struct CamelService"><span class="type">CamelService</span></a> *service</code></em>);</pre>
<p>
Gets the <a class="link" href="camel-camel-provider.html#CamelProvider" title="CamelProvider"><span class="type">CamelProvider</span></a> associated with the service.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
<td>a <a class="link" href="camel-CamelService.html#CamelService" title="struct CamelService"><span class="type">CamelService</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the provider
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_service_query_auth_types ()">
<a name="camel-service-query-auth-types"></a><h3>camel_service_query_auth_types ()</h3>
<pre class="programlisting"><span class="returnvalue">GList</span> * camel_service_query_auth_types (<em class="parameter"><code><a class="link" href="camel-CamelService.html#CamelService" title="struct CamelService"><span class="type">CamelService</span></a> *service</code></em>,
<em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>);</pre>
<p>
This is used by the mail source wizard to get the list of
authentication types supported by the protocol, and information
about them.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
<td>a <a class="link" href="camel-CamelService.html#CamelService" title="struct CamelService"><span class="type">CamelService</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ex</code></em> :</span></p></td>
<td>a <a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a list of <a class="link" href="camel-CamelService.html#CamelServiceAuthType" title="CamelServiceAuthType"><span class="type">CamelServiceAuthType</span></a> records. The caller
must free the list with <span class="type">g_list_free</span> when it is done with it.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.14</div>
</body>
</html>
|
