← Back to branch summary

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

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
https://launchpad.net/bugs/42199
https://launchpad.net/bugs/229669
https://launchpad.net/bugs/173703
https://launchpad.net/bugs/360344
https://launchpad.net/bugs/508494
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/camel/html/camel-CamelTcpStreamSSL.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>CamelTcpStreamSSL</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
7
<link rel="home" href="index.html" title="Camel Reference Manual">
8
8
<link rel="up" href="Streams.html" title="Streams">
9
9
<link rel="prev" href="camel-CamelTcpStreamRaw.html" title="CamelTcpStreamRaw">
10
 
<link rel="next" href="StreamFilters.html" title="Stream Filters">
 
10
<link rel="next" href="Stream-Filters.html" title="Stream Filters">
11
11
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
18
18
<td><a accesskey="u" href="Streams.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
20
<th width="100%" align="center">Camel Reference Manual</th>
21
 
<td><a accesskey="n" href="StreamFilters.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
21
<td><a accesskey="n" href="Stream-Filters.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22
22
</tr>
23
23
<tr><td colspan="5" class="shortcuts">
24
24
<a href="#camel-CamelTcpStreamSSL.synopsis" class="shortcut">Top</a>
26
26
                  <a href="#camel-CamelTcpStreamSSL.description" class="shortcut">Description</a>
27
27
</td></tr>
28
28
</table>
29
 
<div class="refentry" lang="en">
 
29
<div class="refentry" title="CamelTcpStreamSSL">
30
30
<a name="camel-CamelTcpStreamSSL"></a><div class="titlepage"></div>
31
31
<div class="refnamediv"><table width="100%"><tr>
32
32
<td valign="top">
35
35
</td>
36
36
<td valign="top" align="right"></td>
37
37
</tr></table></div>
38
 
<div class="refsynopsisdiv">
 
38
<div class="refsynopsisdiv" title="Synopsis">
39
39
<a name="camel-CamelTcpStreamSSL.synopsis"></a><h2>Synopsis</h2>
40
40
<pre class="synopsis">struct              <a class="link" href="camel-CamelTcpStreamSSL.html#CamelTcpStreamSSL" title="struct CamelTcpStreamSSL">CamelTcpStreamSSL</a>;
41
41
#define             <a class="link" href="camel-CamelTcpStreamSSL.html#CAMEL-TCP-STREAM-SSL-ENABLE-SSL2:CAPS" title="CAMEL_TCP_STREAM_SSL_ENABLE_SSL2">CAMEL_TCP_STREAM_SSL_ENABLE_SSL2</a>
48
48
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *expected_host</code></em>,
49
49
                                                         <em class="parameter"><code><span class="type">guint32</span> flags</code></em>);
50
50
<span class="returnvalue">gint</span>                <a class="link" href="camel-CamelTcpStreamSSL.html#camel-tcp-stream-ssl-enable-ssl" title="camel_tcp_stream_ssl_enable_ssl ()">camel_tcp_stream_ssl_enable_ssl</a>     (<em class="parameter"><code><a class="link" href="camel-CamelTcpStreamSSL.html#CamelTcpStreamSSL" title="struct CamelTcpStreamSSL"><span class="type">CamelTcpStreamSSL</span></a> *ssl</code></em>);
 
51
<span class="returnvalue">PRFileDesc</span> *        <a class="link" href="camel-CamelTcpStreamSSL.html#camel-tcp-stream-ssl-sockfd" title="camel_tcp_stream_ssl_sockfd ()">camel_tcp_stream_ssl_sockfd</a>         (<em class="parameter"><code><a class="link" href="camel-CamelTcpStreamSSL.html#CamelTcpStreamSSL" title="struct CamelTcpStreamSSL"><span class="type">CamelTcpStreamSSL</span></a> *stream</code></em>);
51
52
</pre>
52
53
</div>
53
 
<div class="refsect1" lang="en">
 
54
<div class="refsect1" title="Description">
54
55
<a name="camel-CamelTcpStreamSSL.description"></a><h2>Description</h2>
55
56
<p>
56
57
</p>
57
58
</div>
58
 
<div class="refsect1" lang="en">
 
59
<div class="refsect1" title="Details">
59
60
<a name="camel-CamelTcpStreamSSL.details"></a><h2>Details</h2>
60
 
<div class="refsect2" lang="en">
 
61
<div class="refsect2" title="struct CamelTcpStreamSSL">
61
62
<a name="CamelTcpStreamSSL"></a><h3>struct CamelTcpStreamSSL</h3>
62
63
<pre class="programlisting">struct CamelTcpStreamSSL {
63
64
        CamelTcpStream parent_object;
69
70
</p>
70
71
</div>
71
72
<hr>
72
 
<div class="refsect2" lang="en">
 
73
<div class="refsect2" title="CAMEL_TCP_STREAM_SSL_ENABLE_SSL2">
73
74
<a name="CAMEL-TCP-STREAM-SSL-ENABLE-SSL2:CAPS"></a><h3>CAMEL_TCP_STREAM_SSL_ENABLE_SSL2</h3>
74
75
<pre class="programlisting">#define CAMEL_TCP_STREAM_SSL_ENABLE_SSL2   (1 &lt;&lt; 0)
75
76
</pre>
77
78
</p>
78
79
</div>
79
80
<hr>
80
 
<div class="refsect2" lang="en">
 
81
<div class="refsect2" title="CAMEL_TCP_STREAM_SSL_ENABLE_SSL3">
81
82
<a name="CAMEL-TCP-STREAM-SSL-ENABLE-SSL3:CAPS"></a><h3>CAMEL_TCP_STREAM_SSL_ENABLE_SSL3</h3>
82
83
<pre class="programlisting">#define CAMEL_TCP_STREAM_SSL_ENABLE_SSL3   (1 &lt;&lt; 1)
83
84
</pre>
85
86
</p>
86
87
</div>
87
88
<hr>
88
 
<div class="refsect2" lang="en">
 
89
<div class="refsect2" title="CAMEL_TCP_STREAM_SSL_ENABLE_TLS">
89
90
<a name="CAMEL-TCP-STREAM-SSL-ENABLE-TLS:CAPS"></a><h3>CAMEL_TCP_STREAM_SSL_ENABLE_TLS</h3>
90
91
<pre class="programlisting">#define CAMEL_TCP_STREAM_SSL_ENABLE_TLS    (1 &lt;&lt; 2)
91
92
</pre>
93
94
</p>
94
95
</div>
95
96
<hr>
96
 
<div class="refsect2" lang="en">
 
97
<div class="refsect2" title="camel_tcp_stream_ssl_new ()">
97
98
<a name="camel-tcp-stream-ssl-new"></a><h3>camel_tcp_stream_ssl_new ()</h3>
98
99
<pre class="programlisting"><a class="link" href="camel-CamelStream.html#CamelStream" title="struct CamelStream"><span class="returnvalue">CamelStream</span></a> *       camel_tcp_stream_ssl_new            (<em class="parameter"><code><span class="type">struct _CamelSession</span> *session</code></em>,
99
100
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *expected_host</code></em>,
100
101
                                                         <em class="parameter"><code><span class="type">guint32</span> flags</code></em>);</pre>
101
102
<p>
102
103
Since the SSL certificate authenticator may need to prompt the
103
 
user, a CamelService is needed. <em class="parameter"><code>expected_host</code></em> is needed as a
104
 
protection against an MITM attack.</p>
 
104
user, a <a class="link" href="camel-CamelSession.html#CamelSession" title="struct CamelSession"><span class="type">CamelSession</span></a> is needed. <em class="parameter"><code>expected_host</code></em> is needed as a
 
105
protection against an MITM attack.
 
106
</p>
105
107
<div class="variablelist"><table border="0">
106
108
<col align="left" valign="top">
107
109
<tbody>
108
110
<tr>
109
111
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
110
 
<td>
 
112
<td>an active <a class="link" href="camel-CamelSession.html#CamelSession" title="struct CamelSession"><span class="type">CamelSession</span></a> object
111
113
</td>
112
114
</tr>
113
115
<tr>
114
116
<td><p><span class="term"><em class="parameter"><code>expected_host</code></em> :</span></p></td>
115
 
<td>host that the stream is expecting to connect with.
 
117
<td>host that the stream is expected to connect with
116
118
</td>
117
119
</tr>
118
120
<tr>
119
121
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
120
 
<td>flags
 
122
<td>a bitwise combination of any of
 
123
<a class="link" href="camel-CamelTcpStreamSSL.html#CAMEL-TCP-STREAM-SSL-ENABLE-SSL2:CAPS" title="CAMEL_TCP_STREAM_SSL_ENABLE_SSL2"><span class="type">CAMEL_TCP_STREAM_SSL_ENABLE_SSL2</span></a>,
 
124
<a class="link" href="camel-CamelTcpStreamSSL.html#CAMEL-TCP-STREAM-SSL-ENABLE-SSL3:CAPS" title="CAMEL_TCP_STREAM_SSL_ENABLE_SSL3"><span class="type">CAMEL_TCP_STREAM_SSL_ENABLE_SSL3</span></a> or
 
125
<a class="link" href="camel-CamelTcpStreamSSL.html#CAMEL-TCP-STREAM-SSL-ENABLE-TLS:CAPS" title="CAMEL_TCP_STREAM_SSL_ENABLE_TLS"><span class="type">CAMEL_TCP_STREAM_SSL_ENABLE_TLS</span></a>
121
126
</td>
122
127
</tr>
123
128
<tr>
124
129
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
125
 
<td> a ssl stream (in ssl mode)
 
130
<td> a new <a class="link" href="camel-CamelTcpStreamSSL.html#CamelTcpStreamSSL" title="struct CamelTcpStreamSSL"><span class="type">CamelTcpStreamSSL</span></a> stream preset in SSL mode
126
131
</td>
127
132
</tr>
128
133
</tbody>
129
134
</table></div>
130
135
</div>
131
136
<hr>
132
 
<div class="refsect2" lang="en">
 
137
<div class="refsect2" title="camel_tcp_stream_ssl_new_raw ()">
133
138
<a name="camel-tcp-stream-ssl-new-raw"></a><h3>camel_tcp_stream_ssl_new_raw ()</h3>
134
139
<pre class="programlisting"><a class="link" href="camel-CamelStream.html#CamelStream" title="struct CamelStream"><span class="returnvalue">CamelStream</span></a> *       camel_tcp_stream_ssl_new_raw        (<em class="parameter"><code><span class="type">struct _CamelSession</span> *session</code></em>,
135
140
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *expected_host</code></em>,
136
141
                                                         <em class="parameter"><code><span class="type">guint32</span> flags</code></em>);</pre>
137
142
<p>
138
143
Since the SSL certificate authenticator may need to prompt the
139
 
user, a CamelService is needed. <em class="parameter"><code>expected_host</code></em> is needed as a
140
 
protection against an MITM attack.</p>
 
144
user, a CamelSession is needed. <em class="parameter"><code>expected_host</code></em> is needed as a
 
145
protection against an MITM attack.
 
146
</p>
141
147
<div class="variablelist"><table border="0">
142
148
<col align="left" valign="top">
143
149
<tbody>
144
150
<tr>
145
151
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
146
 
<td>
 
152
<td>an active <a class="link" href="camel-CamelSession.html#CamelSession" title="struct CamelSession"><span class="type">CamelSession</span></a> object
147
153
</td>
148
154
</tr>
149
155
<tr>
150
156
<td><p><span class="term"><em class="parameter"><code>expected_host</code></em> :</span></p></td>
151
 
<td>host that the stream is expecting to connect with.
 
157
<td>host that the stream is expected to connect with
152
158
</td>
153
159
</tr>
154
160
<tr>
155
161
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
156
 
<td>flags
 
162
<td>a bitwise combination of any of
 
163
<a class="link" href="camel-CamelTcpStreamSSL.html#CAMEL-TCP-STREAM-SSL-ENABLE-SSL2:CAPS" title="CAMEL_TCP_STREAM_SSL_ENABLE_SSL2"><span class="type">CAMEL_TCP_STREAM_SSL_ENABLE_SSL2</span></a>,
 
164
<a class="link" href="camel-CamelTcpStreamSSL.html#CAMEL-TCP-STREAM-SSL-ENABLE-SSL3:CAPS" title="CAMEL_TCP_STREAM_SSL_ENABLE_SSL3"><span class="type">CAMEL_TCP_STREAM_SSL_ENABLE_SSL3</span></a> or
 
165
<a class="link" href="camel-CamelTcpStreamSSL.html#CAMEL-TCP-STREAM-SSL-ENABLE-TLS:CAPS" title="CAMEL_TCP_STREAM_SSL_ENABLE_TLS"><span class="type">CAMEL_TCP_STREAM_SSL_ENABLE_TLS</span></a>
157
166
</td>
158
167
</tr>
159
168
<tr>
160
169
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
161
 
<td> a ssl-capable stream (in non ssl mode)
 
170
<td> a new <a class="link" href="camel-CamelTcpStreamSSL.html#CamelTcpStreamSSL" title="struct CamelTcpStreamSSL"><span class="type">CamelTcpStreamSSL</span></a> stream not yet toggled into SSL mode
162
171
</td>
163
172
</tr>
164
173
</tbody>
165
174
</table></div>
166
175
</div>
167
176
<hr>
168
 
<div class="refsect2" lang="en">
 
177
<div class="refsect2" title="camel_tcp_stream_ssl_enable_ssl ()">
169
178
<a name="camel-tcp-stream-ssl-enable-ssl"></a><h3>camel_tcp_stream_ssl_enable_ssl ()</h3>
170
179
<pre class="programlisting"><span class="returnvalue">gint</span>                camel_tcp_stream_ssl_enable_ssl     (<em class="parameter"><code><a class="link" href="camel-CamelTcpStreamSSL.html#CamelTcpStreamSSL" title="struct CamelTcpStreamSSL"><span class="type">CamelTcpStreamSSL</span></a> *ssl</code></em>);</pre>
171
180
<p>
172
 
Toggles an ssl-capable stream into ssl mode (if it isn't already).</p>
 
181
Toggles an ssl-capable stream into ssl mode (if it isn't already).
 
182
</p>
173
183
<div class="variablelist"><table border="0">
174
184
<col align="left" valign="top">
175
185
<tbody>
176
186
<tr>
177
187
<td><p><span class="term"><em class="parameter"><code>ssl</code></em> :</span></p></td>
 
188
<td>a <a class="link" href="camel-CamelTcpStreamSSL.html#CamelTcpStreamSSL" title="struct CamelTcpStreamSSL"><span class="type">CamelTcpStreamSSL</span></a> object
 
189
</td>
 
190
</tr>
 
191
<tr>
 
192
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
193
<td> <code class="literal">0</code> on success or <code class="literal">-1</code> on fail
 
194
</td>
 
195
</tr>
 
196
</tbody>
 
197
</table></div>
 
198
</div>
 
199
<hr>
 
200
<div class="refsect2" title="camel_tcp_stream_ssl_sockfd ()">
 
201
<a name="camel-tcp-stream-ssl-sockfd"></a><h3>camel_tcp_stream_ssl_sockfd ()</h3>
 
202
<pre class="programlisting"><span class="returnvalue">PRFileDesc</span> *        camel_tcp_stream_ssl_sockfd         (<em class="parameter"><code><a class="link" href="camel-CamelTcpStreamSSL.html#CamelTcpStreamSSL" title="struct CamelTcpStreamSSL"><span class="type">CamelTcpStreamSSL</span></a> *stream</code></em>);</pre>
 
203
<p>
 
204
FIXME Document me!
 
205
</p>
 
206
<div class="variablelist"><table border="0">
 
207
<col align="left" valign="top">
 
208
<tbody>
 
209
<tr>
 
210
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
 
211
<td>a <a class="link" href="camel-CamelTcpStreamSSL.html#CamelTcpStreamSSL" title="struct CamelTcpStreamSSL"><span class="type">CamelTcpStreamSSL</span></a>
 
212
</td>
 
213
</tr>
 
214
<tr>
 
215
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
178
216
<td>
179
217
</td>
180
218
</tr>
181
 
<tr>
182
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
183
 
<td> 0 on success or -1 on fail.
184
 
</td>
185
 
</tr>
186
219
</tbody>
187
220
</table></div>
 
221
<p class="since">Since 2.30</p>
188
222
</div>
189
223
</div>
190
224
</div>