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 I. 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>
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>
36
<a href="#id2591271" class="shortcut">Description</a></nobr></td></tr>
36
<a href="#id2619782" class="shortcut">Description</a></nobr></td></tr>
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>
43
<a name="id2590508"></a><span class="refentrytitle">CamelTcpStreamSSL</span>
43
<a name="id2619018"></a><span class="refentrytitle">CamelTcpStreamSSL</span>
45
45
<p>CamelTcpStreamSSL</p>
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,
62
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"
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,
67
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"
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,
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,
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);
74
70
<div class="refsect1" lang="en">
75
<a name="id2591271"></a><h2>Description</h2>
71
<a name="id2619782"></a><h2>Description</h2>
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;
88
84
struct _CamelTcpStreamSSLPrivate *priv;
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 << 0)
95
<a class="indexterm" name="id2619849"></a><pre class="programlisting">#define CAMEL_TCP_STREAM_SSL_ENABLE_SSL2 (1 << 0)
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 << 1)
105
<a class="indexterm" name="id2619880"></a><pre class="programlisting">#define CAMEL_TCP_STREAM_SSL_ENABLE_SSL3 (1 << 1)
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 << 2)
115
<a class="indexterm" name="id2619911"></a><pre class="programlisting">#define CAMEL_TCP_STREAM_SSL_ENABLE_TLS (1 << 2)
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,
132
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"
133
>guint32</a> flags);</pre>
127
guint32 flags);</pre>
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>
142
136
<col align="left" valign="top">
145
<td><span class="term"><em class="parameter"><code>session</code></em> :</span></td>
150
<td><span class="term"><em class="parameter"><code>expected_host</code></em> :</span></td>
151
<td> host that the stream is expecting to connect with.
155
<td><span class="term"><em class="parameter"><code>flags</code></em> :</span></td>
160
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
161
<td> a ssl stream (in ssl mode)
139
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
140
<td> an active <a class="link" href="camel-CamelSession.html#CamelSession"><span class="type">CamelSession</span></a> object
144
<td><p><span class="term"><em class="parameter"><code>expected_host</code></em> :</span></p></td>
145
<td> host that the stream is expected to connect with
149
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</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>
157
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</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
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,
174
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"
175
>guint32</a> flags);</pre>
170
guint32 flags);</pre>
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>
184
179
<col align="left" valign="top">
187
<td><span class="term"><em class="parameter"><code>session</code></em> :</span></td>
192
<td><span class="term"><em class="parameter"><code>expected_host</code></em> :</span></td>
193
<td> host that the stream is expecting to connect with.
197
<td><span class="term"><em class="parameter"><code>flags</code></em> :</span></td>
202
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</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> :</span></p></td>
183
<td> an active <a class="link" href="camel-CamelSession.html#CamelSession"><span class="type">CamelSession</span></a> object
187
<td><p><span class="term"><em class="parameter"><code>expected_host</code></em> :</span></p></td>
188
<td> host that the stream is expected to connect with
192
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</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>
200
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</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
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>
215
213
Toggles an ssl-capable stream into ssl mode (if it isn't already).</p>
220
218
<col align="left" valign="top">
223
<td><span class="term"><em class="parameter"><code>ssl</code></em> :</span></td>
221
<td><p><span class="term"><em class="parameter"><code>ssl</code></em> :</span></p></td>
222
<td> a <a class="link" href="camel-CamelTcpStreamSSL.html#CamelTcpStreamSSL"><span class="type">CamelTcpStreamSSL</span></a> object
226
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
228
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</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