~ubuntu-branches/ubuntu/hardy/evolution-data-server/hardy-updates

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2007-11-13 10:59:20 UTC
  • mfrom: (1.1.38 upstream)
  • Revision ID: james.westby@ubuntu.com-20071113105920-nb6w14udvgx0ghi3
Tags: 2.21.2-0ubuntu1
* New upstream version:
  Bug Fixes:
  - #318842: Task lists should be sorted (LP: #23912)
  - #345135: Disable SSLv2 compatible HELLO on SSL stream when 
    SSLv2 is disabled
  - #359267: Not all memos are showed in calendar view
  - #430420: Returned size <= 0 is an error
  - #460649: Meeting UI Needs To Show Color Of Selected Calendar Source
  - #487229: Use GKeyFile instead of gnome-config to access stored passwords
  - #488156: Minimize use of the WITH_GNOME_KEYRING macro
  - #492130: ESourceSelector uses pointers to ESource
  - #494304: Fix leak
  Updated Translations
  New in 2.21.1:
  - Support for Google Calendar
  Bug Fixes:
  - #203480: (Novell Bugzilla) Compiler warning fix 
    for usage ofunintialized variable
  - #231178: New symbol 'set-label' defined and added corresponding callback
  - #271777: Keep character's case as user types
  - #417999: Don't use deprecated GTK+ symbols
  - #420167: e-d-s now exits with gnome-session
  - #469657: Better use of GHashTable
  - #474000: Use GLib's Base64 API instead of Camel's
  - #475487: When creating the default contact, print errors to the console
  - #475493: Use G_DEFINE_TYPE
  - #475494: Use G_LOCK instead of a static mutex for clearer code
  - #478404: Reset the id to zero
  - #483301: Remove an unused variable
  - #487270: Fix typo in documentation
  - #488173: Remove __FUNCTION__, which is a gcc-ism
  - #488351: Fix an addressbook error on a fresh install
  Other Contributors:
  - Protect against a NULL subject string. 
* debian/*.preinst:
  - On upgrades from Gutsy, remove the symlinks introduced in Gutsy. They
    break upgrades all over, and current cdbs just symlinks individual files.
* Sync with Debian
* debian/control:
  - evolution-data-server Breaks evolution (<< 2.9), 
    evolution-exchange (<= 2.8.1-0ubuntu1),
    evolution-jescs (<= 2.8.2-0ubuntu3), 
    evolution-scalix (<= 10.0.0.357-0ubuntu6)
  - updated maintainer to desktop team
* debian/rules:
  - don't specify the paths for nspr and nss since the package is built 
    with firefox
  - don't build documentation, it's distributed in the upstream tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>CamelTcpStreamSSL</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.73.1">
7
7
<link rel="start" 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
10
<link rel="next" href="Filters.html" title="Stream Filters">
11
 
<meta name="generator" content="GTK-Doc V1.9 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="part" href="classes.html" title="Part&#160;I.&#160;Camel Classes">
14
14
<link rel="chapter" href="ClassTree.html" title="Class hierarchy">
31
31
<th width="100%" align="center">Camel Reference Manual</th>
32
32
<td><a accesskey="n" href="Filters.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
33
33
</tr>
34
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2590508" class="shortcut">Top</a>
 
34
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2619018" class="shortcut">Top</a>
35
35
                  &#160;|&#160;
36
 
                  <a href="#id2591271" class="shortcut">Description</a></nobr></td></tr>
 
36
                  <a href="#id2619782" class="shortcut">Description</a></nobr></td></tr>
37
37
</table>
38
38
<div class="refentry" lang="en">
39
39
<a name="camel-CamelTcpStreamSSL"></a><div class="titlepage"></div>
40
40
<div class="refnamediv"><table width="100%"><tr>
41
41
<td valign="top">
42
42
<h2>
43
 
<a name="id2590508"></a><span class="refentrytitle">CamelTcpStreamSSL</span>
 
43
<a name="id2619018"></a><span class="refentrytitle">CamelTcpStreamSSL</span>
44
44
</h2>
45
45
<p>CamelTcpStreamSSL</p>
46
46
</td>
52
52
 
53
53
 
54
54
 
55
 
struct              <a href="camel-CamelTcpStreamSSL.html#CamelTcpStreamSSL">CamelTcpStreamSSL</a>;
56
 
#define             <a href="camel-CamelTcpStreamSSL.html#CAMEL-TCP-STREAM-SSL-ENABLE-SSL2:CAPS">CAMEL_TCP_STREAM_SSL_ENABLE_SSL2</a>
57
 
#define             <a href="camel-CamelTcpStreamSSL.html#CAMEL-TCP-STREAM-SSL-ENABLE-SSL3:CAPS">CAMEL_TCP_STREAM_SSL_ENABLE_SSL3</a>
58
 
#define             <a href="camel-CamelTcpStreamSSL.html#CAMEL-TCP-STREAM-SSL-ENABLE-TLS:CAPS">CAMEL_TCP_STREAM_SSL_ENABLE_TLS</a>
59
 
<a href="camel-CamelStream.html#CamelStream">CamelStream</a>*        <a href="camel-CamelTcpStreamSSL.html#camel-tcp-stream-ssl-new">camel_tcp_stream_ssl_new</a>            (struct _CamelSession *session,
60
 
                                                         const char *expected_host,
61
 
                                                         <a
62
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"
63
 
>guint32</a> flags);
64
 
<a href="camel-CamelStream.html#CamelStream">CamelStream</a>*        <a href="camel-CamelTcpStreamSSL.html#camel-tcp-stream-ssl-new-raw">camel_tcp_stream_ssl_new_raw</a>        (struct _CamelSession *session,
65
 
                                                         const char *expected_host,
66
 
                                                         <a
67
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"
68
 
>guint32</a> flags);
69
 
int                 <a href="camel-CamelTcpStreamSSL.html#camel-tcp-stream-ssl-enable-ssl">camel_tcp_stream_ssl_enable_ssl</a>     (<a href="camel-CamelTcpStreamSSL.html#CamelTcpStreamSSL">CamelTcpStreamSSL</a> *ssl);
 
55
struct              <a class="link" href="camel-CamelTcpStreamSSL.html#CamelTcpStreamSSL">CamelTcpStreamSSL</a>;
 
56
#define             <a class="link" href="camel-CamelTcpStreamSSL.html#CAMEL-TCP-STREAM-SSL-ENABLE-SSL2:CAPS">CAMEL_TCP_STREAM_SSL_ENABLE_SSL2</a>
 
57
#define             <a class="link" href="camel-CamelTcpStreamSSL.html#CAMEL-TCP-STREAM-SSL-ENABLE-SSL3:CAPS">CAMEL_TCP_STREAM_SSL_ENABLE_SSL3</a>
 
58
#define             <a class="link" href="camel-CamelTcpStreamSSL.html#CAMEL-TCP-STREAM-SSL-ENABLE-TLS:CAPS">CAMEL_TCP_STREAM_SSL_ENABLE_TLS</a>
 
59
<a class="link" href="camel-CamelStream.html#CamelStream">CamelStream</a>*        <a class="link" href="camel-CamelTcpStreamSSL.html#camel-tcp-stream-ssl-new">camel_tcp_stream_ssl_new</a>            (struct _CamelSession *session,
 
60
                                                         const char *expected_host,
 
61
                                                         guint32 flags);
 
62
<a class="link" href="camel-CamelStream.html#CamelStream">CamelStream</a>*        <a class="link" href="camel-CamelTcpStreamSSL.html#camel-tcp-stream-ssl-new-raw">camel_tcp_stream_ssl_new_raw</a>        (struct _CamelSession *session,
 
63
                                                         const char *expected_host,
 
64
                                                         guint32 flags);
 
65
int                 <a class="link" href="camel-CamelTcpStreamSSL.html#camel-tcp-stream-ssl-enable-ssl">camel_tcp_stream_ssl_enable_ssl</a>     (<a class="link" href="camel-CamelTcpStreamSSL.html#CamelTcpStreamSSL">CamelTcpStreamSSL</a> *ssl);
70
66
 
71
67
 
72
68
</pre>
73
69
</div>
74
70
<div class="refsect1" lang="en">
75
 
<a name="id2591271"></a><h2>Description</h2>
 
71
<a name="id2619782"></a><h2>Description</h2>
76
72
<p>
77
73
 
78
74
</p>
79
75
</div>
80
76
<div class="refsect1" lang="en">
81
 
<a name="id2591285"></a><h2>Details</h2>
 
77
<a name="id2619796"></a><h2>Details</h2>
82
78
<div class="refsect2" lang="en">
83
 
<a name="id2591296"></a><h3>
 
79
<a name="id2619806"></a><h3>
84
80
<a name="CamelTcpStreamSSL"></a>struct CamelTcpStreamSSL</h3>
85
 
<a class="indexterm" name="id2591309"></a><pre class="programlisting">struct CamelTcpStreamSSL {
 
81
<a class="indexterm" name="id2619820"></a><pre class="programlisting">struct CamelTcpStreamSSL {
86
82
        CamelTcpStream parent_object;
87
83
        
88
84
        struct _CamelTcpStreamSSLPrivate *priv;
94
90
</div>
95
91
<hr>
96
92
<div class="refsect2" lang="en">
97
 
<a name="id2591325"></a><h3>
 
93
<a name="id2619836"></a><h3>
98
94
<a name="CAMEL-TCP-STREAM-SSL-ENABLE-SSL2:CAPS"></a>CAMEL_TCP_STREAM_SSL_ENABLE_SSL2</h3>
99
 
<a class="indexterm" name="id2591339"></a><pre class="programlisting">#define CAMEL_TCP_STREAM_SSL_ENABLE_SSL2   (1 &lt;&lt; 0)
 
95
<a class="indexterm" name="id2619849"></a><pre class="programlisting">#define CAMEL_TCP_STREAM_SSL_ENABLE_SSL2   (1 &lt;&lt; 0)
100
96
</pre>
101
97
<p>
102
98
 
104
100
</div>
105
101
<hr>
106
102
<div class="refsect2" lang="en">
107
 
<a name="id2591355"></a><h3>
 
103
<a name="id2619866"></a><h3>
108
104
<a name="CAMEL-TCP-STREAM-SSL-ENABLE-SSL3:CAPS"></a>CAMEL_TCP_STREAM_SSL_ENABLE_SSL3</h3>
109
 
<a class="indexterm" name="id2591369"></a><pre class="programlisting">#define CAMEL_TCP_STREAM_SSL_ENABLE_SSL3   (1 &lt;&lt; 1)
 
105
<a class="indexterm" name="id2619880"></a><pre class="programlisting">#define CAMEL_TCP_STREAM_SSL_ENABLE_SSL3   (1 &lt;&lt; 1)
110
106
</pre>
111
107
<p>
112
108
 
114
110
</div>
115
111
<hr>
116
112
<div class="refsect2" lang="en">
117
 
<a name="id2591386"></a><h3>
 
113
<a name="id2619897"></a><h3>
118
114
<a name="CAMEL-TCP-STREAM-SSL-ENABLE-TLS:CAPS"></a>CAMEL_TCP_STREAM_SSL_ENABLE_TLS</h3>
119
 
<a class="indexterm" name="id2591400"></a><pre class="programlisting">#define CAMEL_TCP_STREAM_SSL_ENABLE_TLS    (1 &lt;&lt; 2)
 
115
<a class="indexterm" name="id2619911"></a><pre class="programlisting">#define CAMEL_TCP_STREAM_SSL_ENABLE_TLS    (1 &lt;&lt; 2)
120
116
</pre>
121
117
<p>
122
118
 
124
120
</div>
125
121
<hr>
126
122
<div class="refsect2" lang="en">
127
 
<a name="id2591417"></a><h3>
 
123
<a name="id2619927"></a><h3>
128
124
<a name="camel-tcp-stream-ssl-new"></a>camel_tcp_stream_ssl_new ()</h3>
129
 
<a class="indexterm" name="id2591430"></a><pre class="programlisting"><a href="camel-CamelStream.html#CamelStream">CamelStream</a>*        camel_tcp_stream_ssl_new            (struct _CamelSession *session,
 
125
<a class="indexterm" name="id2619941"></a><pre class="programlisting"><a class="link" href="camel-CamelStream.html#CamelStream">CamelStream</a>*        camel_tcp_stream_ssl_new            (struct _CamelSession *session,
130
126
                                                         const char *expected_host,
131
 
                                                         <a
132
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"
133
 
>guint32</a> flags);</pre>
 
127
                                                         guint32 flags);</pre>
134
128
<p>
135
129
Since the SSL certificate authenticator may need to prompt the
136
 
user, a CamelService is needed. <em class="parameter"><code>expected_host</code></em> is needed as a
 
130
user, a <a class="link" href="camel-CamelSession.html#CamelSession"><span class="type">CamelSession</span></a> is needed. <em class="parameter"><code>expected_host</code></em> is needed as a
137
131
protection against an MITM attack.</p>
138
132
<p>
139
133
 
142
136
<col align="left" valign="top">
143
137
<tbody>
144
138
<tr>
145
 
<td><span class="term"><em class="parameter"><code>session</code></em>&#160;:</span></td>
146
 
<td>
147
 
</td>
148
 
</tr>
149
 
<tr>
150
 
<td><span class="term"><em class="parameter"><code>expected_host</code></em>&#160;:</span></td>
151
 
<td> host that the stream is expecting to connect with.
152
 
</td>
153
 
</tr>
154
 
<tr>
155
 
<td><span class="term"><em class="parameter"><code>flags</code></em>&#160;:</span></td>
156
 
<td> flags
157
 
</td>
158
 
</tr>
159
 
<tr>
160
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
161
 
<td> a ssl stream (in ssl mode)
 
139
<td><p><span class="term"><em class="parameter"><code>session</code></em>&#160;:</span></p></td>
 
140
<td> an active <a class="link" href="camel-CamelSession.html#CamelSession"><span class="type">CamelSession</span></a> object
 
141
</td>
 
142
</tr>
 
143
<tr>
 
144
<td><p><span class="term"><em class="parameter"><code>expected_host</code></em>&#160;:</span></p></td>
 
145
<td> host that the stream is expected to connect with
 
146
</td>
 
147
</tr>
 
148
<tr>
 
149
<td><p><span class="term"><em class="parameter"><code>flags</code></em>&#160;:</span></p></td>
 
150
<td> a bitwise combination of any of
 
151
<a class="link" href="camel-CamelTcpStreamSSL.html#CAMEL-TCP-STREAM-SSL-ENABLE-SSL2:CAPS"><span class="type">CAMEL_TCP_STREAM_SSL_ENABLE_SSL2</span></a>,
 
152
<a class="link" href="camel-CamelTcpStreamSSL.html#CAMEL-TCP-STREAM-SSL-ENABLE-SSL3:CAPS"><span class="type">CAMEL_TCP_STREAM_SSL_ENABLE_SSL3</span></a> or
 
153
<a class="link" href="camel-CamelTcpStreamSSL.html#CAMEL-TCP-STREAM-SSL-ENABLE-TLS:CAPS"><span class="type">CAMEL_TCP_STREAM_SSL_ENABLE_TLS</span></a>
 
154
</td>
 
155
</tr>
 
156
<tr>
 
157
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
158
<td>a new <a class="link" href="camel-CamelTcpStreamSSL.html#CamelTcpStreamSSL"><span class="type">CamelTcpStreamSSL</span></a> stream preset in SSL mode
162
159
</td>
163
160
</tr>
164
161
</tbody>
166
163
</div>
167
164
<hr>
168
165
<div class="refsect2" lang="en">
169
 
<a name="id2591544"></a><h3>
 
166
<a name="id2620108"></a><h3>
170
167
<a name="camel-tcp-stream-ssl-new-raw"></a>camel_tcp_stream_ssl_new_raw ()</h3>
171
 
<a class="indexterm" name="id2591558"></a><pre class="programlisting"><a href="camel-CamelStream.html#CamelStream">CamelStream</a>*        camel_tcp_stream_ssl_new_raw        (struct _CamelSession *session,
 
168
<a class="indexterm" name="id2620121"></a><pre class="programlisting"><a class="link" href="camel-CamelStream.html#CamelStream">CamelStream</a>*        camel_tcp_stream_ssl_new_raw        (struct _CamelSession *session,
172
169
                                                         const char *expected_host,
173
 
                                                         <a
174
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"
175
 
>guint32</a> flags);</pre>
 
170
                                                         guint32 flags);</pre>
176
171
<p>
177
172
Since the SSL certificate authenticator may need to prompt the
178
 
user, a CamelService is needed. <em class="parameter"><code>expected_host</code></em> is needed as a
 
173
user, a CamelSession is needed. <em class="parameter"><code>expected_host</code></em> is needed as a
179
174
protection against an MITM attack.</p>
180
175
<p>
181
176
 
184
179
<col align="left" valign="top">
185
180
<tbody>
186
181
<tr>
187
 
<td><span class="term"><em class="parameter"><code>session</code></em>&#160;:</span></td>
188
 
<td>
189
 
</td>
190
 
</tr>
191
 
<tr>
192
 
<td><span class="term"><em class="parameter"><code>expected_host</code></em>&#160;:</span></td>
193
 
<td> host that the stream is expecting to connect with.
194
 
</td>
195
 
</tr>
196
 
<tr>
197
 
<td><span class="term"><em class="parameter"><code>flags</code></em>&#160;:</span></td>
198
 
<td> flags
199
 
</td>
200
 
</tr>
201
 
<tr>
202
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
203
 
<td> a ssl-capable stream (in non ssl mode)
 
182
<td><p><span class="term"><em class="parameter"><code>session</code></em>&#160;:</span></p></td>
 
183
<td> an active <a class="link" href="camel-CamelSession.html#CamelSession"><span class="type">CamelSession</span></a> object
 
184
</td>
 
185
</tr>
 
186
<tr>
 
187
<td><p><span class="term"><em class="parameter"><code>expected_host</code></em>&#160;:</span></p></td>
 
188
<td> host that the stream is expected to connect with
 
189
</td>
 
190
</tr>
 
191
<tr>
 
192
<td><p><span class="term"><em class="parameter"><code>flags</code></em>&#160;:</span></p></td>
 
193
<td> a bitwise combination of any of
 
194
<a class="link" href="camel-CamelTcpStreamSSL.html#CAMEL-TCP-STREAM-SSL-ENABLE-SSL2:CAPS"><span class="type">CAMEL_TCP_STREAM_SSL_ENABLE_SSL2</span></a>,
 
195
<a class="link" href="camel-CamelTcpStreamSSL.html#CAMEL-TCP-STREAM-SSL-ENABLE-SSL3:CAPS"><span class="type">CAMEL_TCP_STREAM_SSL_ENABLE_SSL3</span></a> or
 
196
<a class="link" href="camel-CamelTcpStreamSSL.html#CAMEL-TCP-STREAM-SSL-ENABLE-TLS:CAPS"><span class="type">CAMEL_TCP_STREAM_SSL_ENABLE_TLS</span></a>
 
197
</td>
 
198
</tr>
 
199
<tr>
 
200
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
201
<td>a new <a class="link" href="camel-CamelTcpStreamSSL.html#CamelTcpStreamSSL"><span class="type">CamelTcpStreamSSL</span></a> stream not yet toggled into SSL mode
204
202
</td>
205
203
</tr>
206
204
</tbody>
208
206
</div>
209
207
<hr>
210
208
<div class="refsect2" lang="en">
211
 
<a name="id2591671"></a><h3>
 
209
<a name="id2620280"></a><h3>
212
210
<a name="camel-tcp-stream-ssl-enable-ssl"></a>camel_tcp_stream_ssl_enable_ssl ()</h3>
213
 
<a class="indexterm" name="id2591684"></a><pre class="programlisting">int                 camel_tcp_stream_ssl_enable_ssl     (<a href="camel-CamelTcpStreamSSL.html#CamelTcpStreamSSL">CamelTcpStreamSSL</a> *ssl);</pre>
 
211
<a class="indexterm" name="id2620293"></a><pre class="programlisting">int                 camel_tcp_stream_ssl_enable_ssl     (<a class="link" href="camel-CamelTcpStreamSSL.html#CamelTcpStreamSSL">CamelTcpStreamSSL</a> *ssl);</pre>
214
212
<p>
215
213
Toggles an ssl-capable stream into ssl mode (if it isn't already).</p>
216
214
<p>
220
218
<col align="left" valign="top">
221
219
<tbody>
222
220
<tr>
223
 
<td><span class="term"><em class="parameter"><code>ssl</code></em>&#160;:</span></td>
 
221
<td><p><span class="term"><em class="parameter"><code>ssl</code></em>&#160;:</span></p></td>
 
222
<td> a <a class="link" href="camel-CamelTcpStreamSSL.html#CamelTcpStreamSSL"><span class="type">CamelTcpStreamSSL</span></a> object
 
223
</td>
 
224
</tr>
 
225
<tr>
 
226
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
224
227
<td>
225
 
</td>
226
 
</tr>
227
 
<tr>
228
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
229
 
<td>0 on success or -1 on fail.
 
228
<code class="literal">0</code> on success or <code class="literal">-1</code> on fail
230
229
</td>
231
230
</tr>
232
231
</tbody>
234
233
</div>
235
234
</div>
236
235
<div class="refsect1" lang="en">
237
 
<a name="id2591746"></a><div class="refsect2" lang="en"><a name="id2591748"></a></div>
 
236
<a name="id2620382"></a><div class="refsect2" lang="en"><a name="id2620383"></a></div>
238
237
<hr>
239
 
<div class="refsect2" lang="en"><a name="id2591749"></a></div>
 
238
<div class="refsect2" lang="en"><a name="id2620384"></a></div>
240
239
</div>
241
240
</div>
242
241
</body>