This file is indexed.

/usr/share/gtk-doc/html/camel/CamelService.html is in libcamel1.2-dev 3.2.3-0ubuntu6.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
<!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.76.1">
<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="CamelNetworkService.html" title="CamelNetworkService">
<meta name="generator" content="GTK-Doc V1.18 (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="CamelNetworkService.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#CamelService.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#CamelService.description" class="shortcut">Description</a>
                   | 
                  <a href="#CamelService.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="CamelService"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="CamelService.top_of_page"></a>CamelService</span></h2>
<p>CamelService</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="CamelService.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct              <a class="link" href="CamelService.html#CamelService-struct" title="struct CamelService">CamelService</a>;
#define             <a class="link" href="CamelService.html#CAMEL-SERVICE-ERROR:CAPS" title="CAMEL_SERVICE_ERROR">CAMEL_SERVICE_ERROR</a>
enum                <a class="link" href="CamelService.html#CamelServiceError" title="enum CamelServiceError">CamelServiceError</a>;
enum                <a class="link" href="CamelService.html#CamelServiceConnectionStatus" title="enum CamelServiceConnectionStatus">CamelServiceConnectionStatus</a>;
                    <a class="link" href="CamelService.html#CamelServiceAuthType" title="CamelServiceAuthType">CamelServiceAuthType</a>;
const <span class="returnvalue">gchar</span> *       <a class="link" href="CamelService.html#camel-service-get-display-name" title="camel_service_get_display_name ()">camel_service_get_display_name</a>      (<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="CamelService.html#camel-service-set-display-name" title="camel_service_set_display_name ()">camel_service_set_display_name</a>      (<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *display_name</code></em>);
const <span class="returnvalue">gchar</span> *       <a class="link" href="CamelService.html#camel-service-get-user-data-dir" title="camel_service_get_user_data_dir ()">camel_service_get_user_data_dir</a>     (<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>);
<span class="returnvalue">gchar</span> *             <a class="link" href="CamelService.html#camel-service-get-name" title="camel_service_get_name ()">camel_service_get_name</a>              (<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> brief</code></em>);
<a class="link" href="camel-camel-provider.html#CamelProvider" title="CamelProvider"><span class="returnvalue">CamelProvider</span></a> *     <a class="link" href="CamelService.html#camel-service-get-provider" title="camel_service_get_provider ()">camel_service_get_provider</a>          (<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>);
struct <a class="link" href="CamelSession.html" title="CamelSession"><span class="returnvalue">_CamelSession</span></a> * <a class="link" href="CamelService.html#camel-service-get-session" title="camel_service_get_session ()">camel_service_get_session</a>        (<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>);
<a class="link" href="CamelSettings.html" title="CamelSettings"><span class="returnvalue">CamelSettings</span></a> *     <a class="link" href="CamelService.html#camel-service-get-settings" title="camel_service_get_settings ()">camel_service_get_settings</a>          (<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="CamelService.html#camel-service-set-settings" title="camel_service_set_settings ()">camel_service_set_settings</a>          (<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>,
                                                         <em class="parameter"><code><a class="link" href="CamelSettings.html" title="CamelSettings"><span class="type">CamelSettings</span></a> *settings</code></em>);
const <span class="returnvalue">gchar</span> *       <a class="link" href="CamelService.html#camel-service-get-uid" title="camel_service_get_uid ()">camel_service_get_uid</a>               (<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>);
<a class="link" href="camel-camel-url.html#CamelURL" title="struct CamelURL"><span class="returnvalue">CamelURL</span></a> *          <a class="link" href="CamelService.html#camel-service-get-camel-url" title="camel_service_get_camel_url ()">camel_service_get_camel_url</a>         (<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>);
<span class="returnvalue">gchar</span> *             <a class="link" href="CamelService.html#camel-service-get-url" title="camel_service_get_url ()">camel_service_get_url</a>               (<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="CamelService.html#camel-service-cancel-connect" title="camel_service_cancel_connect ()">camel_service_cancel_connect</a>        (<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="CamelService.html#camel-service-connect-sync" title="camel_service_connect_sync ()">camel_service_connect_sync</a>          (<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="CamelService.html#camel-service-disconnect-sync" title="camel_service_disconnect_sync ()">camel_service_disconnect_sync</a>       (<em class="parameter"><code><a class="link" href="CamelService.html" title="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><span class="type">GError</span> **error</code></em>);
<a class="link" href="CamelService.html#CamelServiceConnectionStatus" title="enum CamelServiceConnectionStatus"><span class="returnvalue">CamelServiceConnectionStatus</span></a> <a class="link" href="CamelService.html#camel-service-get-connection-status" title="camel_service_get_connection_status ()">camel_service_get_connection_status</a>
                                                        (<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>);
enum                <a class="link" href="CamelService.html#CamelServiceLock" title="enum CamelServiceLock">CamelServiceLock</a>;
<span class="returnvalue">void</span>                <a class="link" href="CamelService.html#camel-service-lock" title="camel_service_lock ()">camel_service_lock</a>                  (<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>,
                                                         <em class="parameter"><code><a class="link" href="CamelService.html#CamelServiceLock" title="enum CamelServiceLock"><span class="type">CamelServiceLock</span></a> lock</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="CamelService.html#camel-service-unlock" title="camel_service_unlock ()">camel_service_unlock</a>                (<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>,
                                                         <em class="parameter"><code><a class="link" href="CamelService.html#CamelServiceLock" title="enum CamelServiceLock"><span class="type">CamelServiceLock</span></a> lock</code></em>);
<span class="returnvalue">GList</span> *             <a class="link" href="CamelService.html#camel-service-query-auth-types-sync" title="camel_service_query_auth_types_sync ()">camel_service_query_auth_types_sync</a> (<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>,
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="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="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> io_priority</code></em>,
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
                                                         <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
<span class="returnvalue">GList</span> *             <a class="link" href="CamelService.html#camel-service-query-auth-types-finish" title="camel_service_query_auth_types_finish ()">camel_service_query_auth_types_finish</a>
                                                        (<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>,
                                                         <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="CamelService.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GObject
   +----<a class="link" href="CamelObject.html" title="CamelObject">CamelObject</a>
         +----CamelService
               +----<a class="link" href="CamelStore.html" title="CamelStore">CamelStore</a>
               +----<a class="link" href="CamelTransport.html" title="CamelTransport">CamelTransport</a>
</pre>
</div>
<div class="refsect1">
<a name="CamelService.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="CamelService.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="CamelService-struct"></a><h3>struct CamelService</h3>
<pre class="programlisting">struct CamelService;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-SERVICE-ERROR:CAPS"></a><h3>CAMEL_SERVICE_ERROR</h3>
<pre class="programlisting">#define             CAMEL_SERVICE_ERROR</pre>
<p class="since">Since 2.32</p>
</div>
<hr>
<div class="refsect2">
<a name="CamelServiceError"></a><h3>enum CamelServiceError</h3>
<pre class="programlisting">typedef enum {
	CAMEL_SERVICE_ERROR_INVALID,
	CAMEL_SERVICE_ERROR_URL_INVALID,
	CAMEL_SERVICE_ERROR_UNAVAILABLE,
	CAMEL_SERVICE_ERROR_CANT_AUTHENTICATE,
	CAMEL_SERVICE_ERROR_NOT_CONNECTED
} CamelServiceError;
</pre>
<p class="since">Since 2.32</p>
</div>
<hr>
<div class="refsect2">
<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">
<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">
<a name="camel-service-get-display-name"></a><h3>camel_service_get_display_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       camel_service_get_display_name      (<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>);</pre>
<p>
Returns the display name for <em class="parameter"><code>service</code></em>, or <code class="literal">NULL</code> if <em class="parameter"><code>service</code></em> has not
been given a display name.  The display name is intended for use in
a user interface and should generally be given a user-defined name.
</p>
<p>
Compare this with <a class="link" href="CamelService.html#camel-service-get-name" title="camel_service_get_name ()"><code class="function">camel_service_get_name()</code></a>, which returns a built-in
description of the type of service (IMAP, SMTP, etc.).
</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="CamelService.html" title="CamelService"><span class="type">CamelService</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the display name for <em class="parameter"><code>service</code></em>, or <code class="literal">NULL</code>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-service-set-display-name"></a><h3>camel_service_set_display_name ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                camel_service_set_display_name      (<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *display_name</code></em>);</pre>
<p>
Assigns a UTF-8 display name to <em class="parameter"><code>service</code></em>.  The display name is intended
for use in a user interface and should generally be given a user-defined
name.
</p>
<p>
Compare this with <a class="link" href="CamelService.html#camel-service-get-name" title="camel_service_get_name ()"><code class="function">camel_service_get_name()</code></a>, which returns a built-in
description of the type of service (IMAP, SMTP, etc.).
</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="CamelService.html" title="CamelService"><span class="type">CamelService</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>display_name</code></em> :</span></p></td>
<td>a valid UTF-8 string, or <code class="literal">NULL</code>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-service-get-user-data-dir"></a><h3>camel_service_get_user_data_dir ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       camel_service_get_user_data_dir     (<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>);</pre>
<p>
Returns the base directory under which to store user-specific data
for <em class="parameter"><code>service</code></em>.  The directory is formed by appending the directory
returned by <a class="link" href="CamelSession.html#camel-session-get-user-data-dir" title="camel_session_get_user_data_dir ()"><code class="function">camel_session_get_user_data_dir()</code></a> with the service's
<span class="type">"uid"</span> value.
</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="CamelService.html" title="CamelService"><span class="type">CamelService</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the base directory for <em class="parameter"><code>service</code></em>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<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="CamelService.html" title="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="CamelService.html" title="CamelService"><span class="type">CamelService</span></a>
</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">
<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="CamelService.html" title="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="CamelService.html" title="CamelService"><span class="type">CamelService</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a class="link" href="camel-camel-provider.html#CamelProvider" title="CamelProvider"><span class="type">CamelProvider</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-service-get-session"></a><h3>camel_service_get_session ()</h3>
<pre class="programlisting">struct <a class="link" href="CamelSession.html" title="CamelSession"><span class="returnvalue">_CamelSession</span></a> * camel_service_get_session        (<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>);</pre>
<p>
Gets the <a class="link" href="CamelSession.html" title="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="CamelService.html" title="CamelService"><span class="type">CamelService</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-service-get-settings"></a><h3>camel_service_get_settings ()</h3>
<pre class="programlisting"><a class="link" href="CamelSettings.html" title="CamelSettings"><span class="returnvalue">CamelSettings</span></a> *     camel_service_get_settings          (<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>);</pre>
<p>
Returns the <a class="link" href="CamelSettings.html" title="CamelSettings"><span class="type">CamelSettings</span></a> instance 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="CamelService.html" title="CamelService"><span class="type">CamelService</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a class="link" href="CamelSettings.html" title="CamelSettings"><span class="type">CamelSettings</span></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-service-set-settings"></a><h3>camel_service_set_settings ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                camel_service_set_settings          (<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>,
                                                         <em class="parameter"><code><a class="link" href="CamelSettings.html" title="CamelSettings"><span class="type">CamelSettings</span></a> *settings</code></em>);</pre>
<p>
Associates a new <a class="link" href="CamelSettings.html" title="CamelSettings"><span class="type">CamelSettings</span></a> instance with the service.
The <em class="parameter"><code>settings</code></em> instance must match the settings type defined in
<span class="type">CamelServiceClass</span>.  If <em class="parameter"><code>settings</code></em> is <code class="literal">NULL</code>, a new <a class="link" href="CamelSettings.html" title="CamelSettings"><span class="type">CamelSettings</span></a>
instance of the appropriate type is created with all properties
set to defaults.
</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="CamelService.html" title="CamelService"><span class="type">CamelService</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>an instance derviced from <a class="link" href="CamelSettings.html" title="CamelSettings"><span class="type">CamelSettings</span></a>, or <code class="literal">NULL</code>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-service-get-uid"></a><h3>camel_service_get_uid ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       camel_service_get_uid               (<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>);</pre>
<p>
Gets the unique identifier string 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="CamelService.html" title="CamelService"><span class="type">CamelService</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the UID string</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-service-get-camel-url"></a><h3>camel_service_get_camel_url ()</h3>
<pre class="programlisting"><a class="link" href="camel-camel-url.html#CamelURL" title="struct CamelURL"><span class="returnvalue">CamelURL</span></a> *          camel_service_get_camel_url         (<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>);</pre>
<p>
Returns the <a class="link" href="camel-camel-url.html#CamelURL" title="struct CamelURL"><span class="type">CamelURL</span></a> representing <em class="parameter"><code>service</code></em>.
</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="CamelService.html" title="CamelService"><span class="type">CamelService</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a class="link" href="camel-camel-url.html#CamelURL" title="struct CamelURL"><span class="type">CamelURL</span></a> representing <em class="parameter"><code>service</code></em>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<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="CamelService.html" title="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="CamelService.html" title="CamelService"><span class="type">CamelService</span></a>
</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">
<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="CamelService.html" title="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="CamelService.html" title="CamelService"><span class="type">CamelService</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-service-connect-sync"></a><h3>camel_service_connect_sync ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            camel_service_connect_sync          (<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</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="CamelService.html" title="CamelService"><span class="type">CamelService</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</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">
<a name="camel-service-disconnect-sync"></a><h3>camel_service_disconnect_sync ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            camel_service_disconnect_sync       (<em class="parameter"><code><a class="link" href="CamelService.html" title="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><span class="type">GError</span> **error</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="CamelService.html" title="CamelService"><span class="type">CamelService</span></a>
</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>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</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">
<a name="camel-service-get-connection-status"></a><h3>camel_service_get_connection_status ()</h3>
<pre class="programlisting"><a class="link" href="CamelService.html#CamelServiceConnectionStatus" title="enum CamelServiceConnectionStatus"><span class="returnvalue">CamelServiceConnectionStatus</span></a> camel_service_get_connection_status
                                                        (<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>);</pre>
<p>
Returns the connection status for <em class="parameter"><code>service</code></em>.
</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="CamelService.html" title="CamelService"><span class="type">CamelService</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the connection status</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="CamelServiceLock"></a><h3>enum CamelServiceLock</h3>
<pre class="programlisting">typedef enum {
	CAMEL_SERVICE_REC_CONNECT_LOCK,
	CAMEL_SERVICE_CONNECT_OP_LOCK
} CamelServiceLock;
</pre>
<p class="since">Since 2.32</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-service-lock"></a><h3>camel_service_lock ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                camel_service_lock                  (<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>,
                                                         <em class="parameter"><code><a class="link" href="CamelService.html#CamelServiceLock" title="enum CamelServiceLock"><span class="type">CamelServiceLock</span></a> lock</code></em>);</pre>
<p>
Locks <em class="parameter"><code>service</code></em>'s <em class="parameter"><code>lock</code></em>. Unlock it with <a class="link" href="CamelService.html#camel-service-unlock" title="camel_service_unlock ()"><code class="function">camel_service_unlock()</code></a>.
</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="CamelService.html" title="CamelService"><span class="type">CamelService</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>lock</code></em> :</span></p></td>
<td>lock type to lock</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.32</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-service-unlock"></a><h3>camel_service_unlock ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                camel_service_unlock                (<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>,
                                                         <em class="parameter"><code><a class="link" href="CamelService.html#CamelServiceLock" title="enum CamelServiceLock"><span class="type">CamelServiceLock</span></a> lock</code></em>);</pre>
<p>
Unlocks <em class="parameter"><code>service</code></em>'s <em class="parameter"><code>lock</code></em>, previously locked with <a class="link" href="CamelService.html#camel-service-lock" title="camel_service_lock ()"><code class="function">camel_service_lock()</code></a>.
</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="CamelService.html" title="CamelService"><span class="type">CamelService</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>lock</code></em> :</span></p></td>
<td>lock type to unlock</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.32</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-service-query-auth-types-sync"></a><h3>camel_service_query_auth_types_sync ()</h3>
<pre class="programlisting"><span class="returnvalue">GList</span> *             camel_service_query_auth_types_sync (<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>,
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Obtains a list of authentication types supported by <em class="parameter"><code>service</code></em>.
Free the returned list with <code class="function">g_list_free()</code>.
</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="CamelService.html" title="CamelService"><span class="type">CamelService</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>optional <span class="type">GCancellable</span> object, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</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="CamelService.html#CamelServiceAuthType" title="CamelServiceAuthType"><span class="type">CamelServiceAuthType</span></a> structs</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-service-query-auth-types"></a><h3>camel_service_query_auth_types ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                camel_service_query_auth_types      (<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> io_priority</code></em>,
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
                                                         <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>
Asynchronously obtains a list of authentication types supported by
<em class="parameter"><code>service</code></em>.
</p>
<p>
When the operation is finished, <em class="parameter"><code>callback</code></em> will be called.  You can
then call <a class="link" href="CamelService.html#camel-service-query-auth-types-finish" title="camel_service_query_auth_types_finish ()"><code class="function">camel_service_query_auth_types_finish()</code></a> to get the result
of the operation.
</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="CamelService.html" title="CamelService"><span class="type">CamelService</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>io_priority</code></em> :</span></p></td>
<td>the I/O priority of the request</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>optional <span class="type">GCancellable</span> object, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>a <span class="type">GAsyncReadyCallback</span> to call when the request is satisfied</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>data to pass to the callback function</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-service-query-auth-types-finish"></a><h3>camel_service_query_auth_types_finish ()</h3>
<pre class="programlisting"><span class="returnvalue">GList</span> *             camel_service_query_auth_types_finish
                                                        (<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>,
                                                         <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Finishes the operation started with <a class="link" href="CamelService.html#camel-service-query-auth-types" title="camel_service_query_auth_types ()"><code class="function">camel_service_query_auth_types()</code></a>.
Free the returned list with <code class="function">g_list_free()</code>.
</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="CamelService.html" title="CamelService"><span class="type">CamelService</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
<td>a <span class="type">GAsyncResult</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</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="CamelService.html#CamelServiceAuthType" title="CamelServiceAuthType"><span class="type">CamelServiceAuthType</span></a> structs</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>