← Back to branch summary

~ubuntu-branches/ubuntu/precise/evolution-data-server/precise-proposed

« back to all changes in this revision

Viewing changes to docs/reference/camel/html/camel-CamelNetworkService.html

  • Committer: Bazaar Package Importer
  • Author(s): Mathieu Trudel-Lapierre
  • Date: 2011-07-27 11:45:30 UTC
  • mfrom: (1.1.90 upstream)
  • Revision ID: james.westby@ubuntu.com-20110727114530-v4ntbu728os68b0b
Tags: 3.1.4-0ubuntu1
* New upstream version.
* debian/patches/999git_EDS_3_1_3_1_to_f94a069.patch: drop, included in
  the upstream 3.1.4 tarball.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/camel/html/camel-CamelNetworkService.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>CamelNetworkService</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 
7
<link rel="home" href="index.html" title="Camel Reference Manual">
 
8
<link rel="up" href="Services.html" title="Services">
 
9
<link rel="prev" href="CamelService.html" title="CamelService">
 
10
<link rel="next" href="CamelStore.html" title="CamelStore">
 
11
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
16
<tr valign="middle">
 
17
<td><a accesskey="p" href="CamelService.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="Services.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
20
<th width="100%" align="center">Camel Reference Manual</th>
 
21
<td><a accesskey="n" href="CamelStore.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
22
</tr>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#camel-CamelNetworkService.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#camel-CamelNetworkService.description" class="shortcut">Description</a>
 
27
</td></tr>
 
28
</table>
 
29
<div class="refentry">
 
30
<a name="camel-CamelNetworkService"></a><div class="titlepage"></div>
 
31
<div class="refnamediv"><table width="100%"><tr>
 
32
<td valign="top">
 
33
<h2><span class="refentrytitle"><a name="camel-CamelNetworkService.top_of_page"></a>CamelNetworkService</span></h2>
 
34
<p>CamelNetworkService</p>
 
35
</td>
 
36
<td valign="top" align="right"></td>
 
37
</tr></table></div>
 
38
<div class="refsynopsisdiv">
 
39
<a name="camel-CamelNetworkService.synopsis"></a><h2>Synopsis</h2>
 
40
<pre class="synopsis">                    <a class="link" href="camel-CamelNetworkService.html#CamelNetworkService" title="CamelNetworkService">CamelNetworkService</a>;
 
41
<span class="returnvalue">guint16</span>             <a class="link" href="camel-CamelNetworkService.html#camel-network-service-get-default-port" title="camel_network_service_get_default_port ()">camel_network_service_get_default_port</a>
 
42
                                                        (<em class="parameter"><code><a class="link" href="camel-CamelNetworkService.html#CamelNetworkService" title="CamelNetworkService"><span class="type">CamelNetworkService</span></a> *service</code></em>);
 
43
const <span class="returnvalue">gchar</span> *       <a class="link" href="camel-CamelNetworkService.html#camel-network-service-get-service-name" title="camel_network_service_get_service_name ()">camel_network_service_get_service_name</a>
 
44
                                                        (<em class="parameter"><code><a class="link" href="camel-CamelNetworkService.html#CamelNetworkService" title="CamelNetworkService"><span class="type">CamelNetworkService</span></a> *service</code></em>);
 
45
enum                <a class="link" href="camel-CamelNetworkService.html#CamelNetworkSecurityMethod" title="enum CamelNetworkSecurityMethod">CamelNetworkSecurityMethod</a>;
 
46
<a class="link" href="camel-CamelNetworkService.html#CamelNetworkSecurityMethod" title="enum CamelNetworkSecurityMethod"><span class="returnvalue">CamelNetworkSecurityMethod</span></a> <a class="link" href="camel-CamelNetworkService.html#camel-network-service-get-security-method" title="camel_network_service_get_security_method ()">camel_network_service_get_security_method</a>
 
47
                                                        (<em class="parameter"><code><a class="link" href="camel-CamelNetworkService.html#CamelNetworkService" title="CamelNetworkService"><span class="type">CamelNetworkService</span></a> *service</code></em>);
 
48
<span class="returnvalue">void</span>                <a class="link" href="camel-CamelNetworkService.html#camel-network-service-set-security-method" title="camel_network_service_set_security_method ()">camel_network_service_set_security_method</a>
 
49
                                                        (<em class="parameter"><code><a class="link" href="camel-CamelNetworkService.html#CamelNetworkService" title="CamelNetworkService"><span class="type">CamelNetworkService</span></a> *service</code></em>,
 
50
                                                         <em class="parameter"><code><a class="link" href="camel-CamelNetworkService.html#CamelNetworkSecurityMethod" title="enum CamelNetworkSecurityMethod"><span class="type">CamelNetworkSecurityMethod</span></a> method</code></em>);
 
51
<a class="link" href="CamelStream.html" title="CamelStream"><span class="returnvalue">CamelStream</span></a> *       <a class="link" href="camel-CamelNetworkService.html#camel-network-service-connect-sync" title="camel_network_service_connect_sync ()">camel_network_service_connect_sync</a>  (<em class="parameter"><code><a class="link" href="camel-CamelNetworkService.html#CamelNetworkService" title="CamelNetworkService"><span class="type">CamelNetworkService</span></a> *service</code></em>,
 
52
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
53
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
 
54
</pre>
 
55
</div>
 
56
<div class="refsect1">
 
57
<a name="camel-CamelNetworkService.description"></a><h2>Description</h2>
 
58
<p>
 
59
</p>
 
60
</div>
 
61
<div class="refsect1">
 
62
<a name="camel-CamelNetworkService.details"></a><h2>Details</h2>
 
63
<div class="refsect2">
 
64
<a name="CamelNetworkService"></a><h3>CamelNetworkService</h3>
 
65
<pre class="programlisting">typedef struct _CamelNetworkService CamelNetworkService;</pre>
 
66
<p>
 
67
</p>
 
68
</div>
 
69
<hr>
 
70
<div class="refsect2">
 
71
<a name="camel-network-service-get-default-port"></a><h3>camel_network_service_get_default_port ()</h3>
 
72
<pre class="programlisting"><span class="returnvalue">guint16</span>             camel_network_service_get_default_port
 
73
                                                        (<em class="parameter"><code><a class="link" href="camel-CamelNetworkService.html#CamelNetworkService" title="CamelNetworkService"><span class="type">CamelNetworkService</span></a> *service</code></em>);</pre>
 
74
<p>
 
75
Returns the default network port number of <em class="parameter"><code>service</code></em> as defined
 
76
in /etc/services.  The default port may depend on the value of the
 
77
<span class="type">"security-method"</span> property.  For example, the
 
78
default port for unencrypted IMAP or encrypted IMAP using STARTTLS
 
79
is 143, but the default port for IMAP over SSL is 993.
 
80
</p>
 
81
<div class="variablelist"><table border="0">
 
82
<col align="left" valign="top">
 
83
<tbody>
 
84
<tr>
 
85
<td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
 
86
<td>a <a class="link" href="camel-CamelNetworkService.html#CamelNetworkService" title="CamelNetworkService"><span class="type">CamelNetworkService</span></a>
 
87
</td>
 
88
</tr>
 
89
<tr>
 
90
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
91
<td>the default port number for <em class="parameter"><code>service</code></em>
 
92
</td>
 
93
</tr>
 
94
</tbody>
 
95
</table></div>
 
96
<p class="since">Since 3.2</p>
 
97
</div>
 
98
<hr>
 
99
<div class="refsect2">
 
100
<a name="camel-network-service-get-service-name"></a><h3>camel_network_service_get_service_name ()</h3>
 
101
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       camel_network_service_get_service_name
 
102
                                                        (<em class="parameter"><code><a class="link" href="camel-CamelNetworkService.html#CamelNetworkService" title="CamelNetworkService"><span class="type">CamelNetworkService</span></a> *service</code></em>);</pre>
 
103
<p>
 
104
Returns the standard network service name for <em class="parameter"><code>service</code></em> as defined
 
105
in /etc/services.  The service name may depend on the value of the
 
106
<span class="type">"security-method"</span> property.  For example, the
 
107
service name for unencrypted IMAP or encrypted IMAP using STARTTLS
 
108
is "imap", but the service name for IMAP over SSL is "imaps".
 
109
</p>
 
110
<div class="variablelist"><table border="0">
 
111
<col align="left" valign="top">
 
112
<tbody>
 
113
<tr>
 
114
<td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
 
115
<td>a <a class="link" href="camel-CamelNetworkService.html#CamelNetworkService" title="CamelNetworkService"><span class="type">CamelNetworkService</span></a>
 
116
</td>
 
117
</tr>
 
118
<tr>
 
119
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
120
<td>the network service name for <em class="parameter"><code>service</code></em>, or <code class="literal">NULL</code>
 
121
</td>
 
122
</tr>
 
123
</tbody>
 
124
</table></div>
 
125
<p class="since">Since 3.2</p>
 
126
</div>
 
127
<hr>
 
128
<div class="refsect2">
 
129
<a name="CamelNetworkSecurityMethod"></a><h3>enum CamelNetworkSecurityMethod</h3>
 
130
<pre class="programlisting">typedef enum {
 
131
        CAMEL_NETWORK_SECURITY_METHOD_NONE,
 
132
        CAMEL_NETWORK_SECURITY_METHOD_SSL_ON_ALTERNATE_PORT,
 
133
        CAMEL_NETWORK_SECURITY_METHOD_STARTTLS_ON_STANDARD_PORT
 
134
} CamelNetworkSecurityMethod;
 
135
</pre>
 
136
<p>
 
137
Methods for establishing an encrypted (or unencrypted) network connection.
 
138
</p>
 
139
<div class="variablelist"><table border="0">
 
140
<col align="left" valign="top">
 
141
<tbody>
 
142
<tr>
 
143
<td><p><a name="CAMEL-NETWORK-SECURITY-METHOD-NONE:CAPS"></a><span class="term"><code class="literal">CAMEL_NETWORK_SECURITY_METHOD_NONE</code></span></p></td>
 
144
<td>  Use an unencrypted network connection.
 
145
</td>
 
146
</tr>
 
147
<tr>
 
148
<td><p><a name="CAMEL-NETWORK-SECURITY-METHOD-SSL-ON-ALTERNATE-PORT:CAPS"></a><span class="term"><code class="literal">CAMEL_NETWORK_SECURITY_METHOD_SSL_ON_ALTERNATE_PORT</code></span></p></td>
 
149
<td>  Use SSL by connecting to an alternate port number.
 
150
</td>
 
151
</tr>
 
152
<tr>
 
153
<td><p><a name="CAMEL-NETWORK-SECURITY-METHOD-STARTTLS-ON-STANDARD-PORT:CAPS"></a><span class="term"><code class="literal">CAMEL_NETWORK_SECURITY_METHOD_STARTTLS_ON_STANDARD_PORT</code></span></p></td>
 
154
<td>  Use SSL or TLS by connecting to the standard port and invoking
 
155
  STARTTLS before authenticating.  This is the recommended method.
 
156
</td>
 
157
</tr>
 
158
</tbody>
 
159
</table></div>
 
160
<p class="since">Since 3.2</p>
 
161
</div>
 
162
<hr>
 
163
<div class="refsect2">
 
164
<a name="camel-network-service-get-security-method"></a><h3>camel_network_service_get_security_method ()</h3>
 
165
<pre class="programlisting"><a class="link" href="camel-CamelNetworkService.html#CamelNetworkSecurityMethod" title="enum CamelNetworkSecurityMethod"><span class="returnvalue">CamelNetworkSecurityMethod</span></a> camel_network_service_get_security_method
 
166
                                                        (<em class="parameter"><code><a class="link" href="camel-CamelNetworkService.html#CamelNetworkService" title="CamelNetworkService"><span class="type">CamelNetworkService</span></a> *service</code></em>);</pre>
 
167
<p>
 
168
Return the method used to establish a secure (or unsecure) network
 
169
connection.
 
170
</p>
 
171
<div class="variablelist"><table border="0">
 
172
<col align="left" valign="top">
 
173
<tbody>
 
174
<tr>
 
175
<td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
 
176
<td>a <a class="link" href="camel-CamelNetworkService.html#CamelNetworkService" title="CamelNetworkService"><span class="type">CamelNetworkService</span></a>
 
177
</td>
 
178
</tr>
 
179
<tr>
 
180
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
181
<td>the security method</td>
 
182
</tr>
 
183
</tbody>
 
184
</table></div>
 
185
<p class="since">Since 3.2</p>
 
186
</div>
 
187
<hr>
 
188
<div class="refsect2">
 
189
<a name="camel-network-service-set-security-method"></a><h3>camel_network_service_set_security_method ()</h3>
 
190
<pre class="programlisting"><span class="returnvalue">void</span>                camel_network_service_set_security_method
 
191
                                                        (<em class="parameter"><code><a class="link" href="camel-CamelNetworkService.html#CamelNetworkService" title="CamelNetworkService"><span class="type">CamelNetworkService</span></a> *service</code></em>,
 
192
                                                         <em class="parameter"><code><a class="link" href="camel-CamelNetworkService.html#CamelNetworkSecurityMethod" title="enum CamelNetworkSecurityMethod"><span class="type">CamelNetworkSecurityMethod</span></a> method</code></em>);</pre>
 
193
<p>
 
194
Sets the method used to establish a secure (or unsecure) network
 
195
connection.  Note that changing this setting has no effect on an
 
196
already-established network connection.
 
197
</p>
 
198
<div class="variablelist"><table border="0">
 
199
<col align="left" valign="top">
 
200
<tbody>
 
201
<tr>
 
202
<td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
 
203
<td>a <a class="link" href="camel-CamelNetworkService.html#CamelNetworkService" title="CamelNetworkService"><span class="type">CamelNetworkService</span></a>
 
204
</td>
 
205
</tr>
 
206
<tr>
 
207
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
 
208
<td>the security method</td>
 
209
</tr>
 
210
</tbody>
 
211
</table></div>
 
212
<p class="since">Since 3.2</p>
 
213
</div>
 
214
<hr>
 
215
<div class="refsect2">
 
216
<a name="camel-network-service-connect-sync"></a><h3>camel_network_service_connect_sync ()</h3>
 
217
<pre class="programlisting"><a class="link" href="CamelStream.html" title="CamelStream"><span class="returnvalue">CamelStream</span></a> *       camel_network_service_connect_sync  (<em class="parameter"><code><a class="link" href="camel-CamelNetworkService.html#CamelNetworkService" title="CamelNetworkService"><span class="type">CamelNetworkService</span></a> *service</code></em>,
 
218
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
219
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
220
<p>
 
221
Attempts to establish a network connection to the server described by
 
222
<em class="parameter"><code>service</code></em>, using the preferred <span class="type">"security-method"</span> to
 
223
secure the connection.  If a connection cannot be established, or the
 
224
connection attempt is cancelled, the function sets <em class="parameter"><code>error</code></em> and returns
 
225
<code class="literal">NULL</code>.
 
226
</p>
 
227
<div class="variablelist"><table border="0">
 
228
<col align="left" valign="top">
 
229
<tbody>
 
230
<tr>
 
231
<td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
 
232
<td>a <a class="link" href="camel-CamelNetworkService.html#CamelNetworkService" title="CamelNetworkService"><span class="type">CamelNetworkService</span></a>
 
233
</td>
 
234
</tr>
 
235
<tr>
 
236
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
237
<td>optional <span class="type">GCancellable</span> object, or <code class="literal">NULL</code>
 
238
</td>
 
239
</tr>
 
240
<tr>
 
241
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
242
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
 
243
</td>
 
244
</tr>
 
245
<tr>
 
246
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
247
<td>a <a class="link" href="CamelStream.html" title="CamelStream"><span class="type">CamelStream</span></a>, or <code class="literal">NULL</code>
 
248
</td>
 
249
</tr>
 
250
</tbody>
 
251
</table></div>
 
252
<p class="since">Since 3.2</p>
 
253
</div>
 
254
</div>
 
255
</div>
 
256
<div class="footer">
 
257
<hr>
 
258
          Generated by GTK-Doc V1.17</div>
 
259
</body>
 
260
</html>
 
 
b'\\ No newline at end of file'