/usr/share/gtk-doc/html/camel/camel-CamelTcpStreamSSL.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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CamelTcpStreamSSL</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="Streams.html" title="Streams">
<link rel="prev" href="CamelTcpStreamRaw.html" title="CamelTcpStreamRaw">
<link rel="next" href="Stream-Filters.html" title="Stream Filters">
<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="CamelTcpStreamRaw.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="Streams.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="Stream-Filters.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#camel-CamelTcpStreamSSL.synopsis" class="shortcut">Top</a>
|
<a href="#camel-CamelTcpStreamSSL.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="camel-CamelTcpStreamSSL"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="camel-CamelTcpStreamSSL.top_of_page"></a>CamelTcpStreamSSL</span></h2>
<p>CamelTcpStreamSSL</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="camel-CamelTcpStreamSSL.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="camel-CamelTcpStreamSSL.html#CamelTcpStreamSSL" title="struct CamelTcpStreamSSL">CamelTcpStreamSSL</a>;
enum <a class="link" href="camel-CamelTcpStreamSSL.html#CamelTcpStreamSSLFlags" title="enum CamelTcpStreamSSLFlags">CamelTcpStreamSSLFlags</a>;
<a class="link" href="CamelStream.html" title="CamelStream"><span class="returnvalue">CamelStream</span></a> * <a class="link" href="camel-CamelTcpStreamSSL.html#camel-tcp-stream-ssl-new" title="camel_tcp_stream_ssl_new ()">camel_tcp_stream_ssl_new</a> (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *expected_host</code></em>,
<em class="parameter"><code><a class="link" href="camel-CamelTcpStreamSSL.html#CamelTcpStreamSSLFlags" title="enum CamelTcpStreamSSLFlags"><span class="type">CamelTcpStreamSSLFlags</span></a> flags</code></em>);
<a class="link" href="CamelStream.html" title="CamelStream"><span class="returnvalue">CamelStream</span></a> * <a class="link" href="camel-CamelTcpStreamSSL.html#camel-tcp-stream-ssl-new-raw" title="camel_tcp_stream_ssl_new_raw ()">camel_tcp_stream_ssl_new_raw</a> (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *expected_host</code></em>,
<em class="parameter"><code><a class="link" href="camel-CamelTcpStreamSSL.html#CamelTcpStreamSSLFlags" title="enum CamelTcpStreamSSLFlags"><span class="type">CamelTcpStreamSSLFlags</span></a> flags</code></em>);
<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>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="camel-CamelTcpStreamSSL.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="camel-CamelTcpStreamSSL.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="CamelTcpStreamSSL"></a><h3>struct CamelTcpStreamSSL</h3>
<pre class="programlisting">struct CamelTcpStreamSSL {
CamelTcpStreamRaw parent_object;
CamelTcpStreamSSLPrivate *priv;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CamelTcpStreamSSLFlags"></a><h3>enum CamelTcpStreamSSLFlags</h3>
<pre class="programlisting">typedef enum {
/*< flags >*/
CAMEL_TCP_STREAM_SSL_ENABLE_SSL2 = 1 << 0,
CAMEL_TCP_STREAM_SSL_ENABLE_SSL3 = 1 << 1,
CAMEL_TCP_STREAM_SSL_ENABLE_TLS = 1 << 2
} CamelTcpStreamSSLFlags;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-tcp-stream-ssl-new"></a><h3>camel_tcp_stream_ssl_new ()</h3>
<pre class="programlisting"><a class="link" href="CamelStream.html" title="CamelStream"><span class="returnvalue">CamelStream</span></a> * camel_tcp_stream_ssl_new (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *expected_host</code></em>,
<em class="parameter"><code><a class="link" href="camel-CamelTcpStreamSSL.html#CamelTcpStreamSSLFlags" title="enum CamelTcpStreamSSLFlags"><span class="type">CamelTcpStreamSSLFlags</span></a> flags</code></em>);</pre>
<p>
Since the SSL certificate authenticator may need to prompt the
user, a <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> is needed. <em class="parameter"><code>expected_host</code></em> is needed as a
protection against an MITM attack.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>an active <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>expected_host</code></em> :</span></p></td>
<td>host that the stream is expected to connect with</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
<td>a bitwise combination of <a class="link" href="camel-CamelTcpStreamSSL.html#CamelTcpStreamSSLFlags" title="enum CamelTcpStreamSSLFlags"><span class="type">CamelTcpStreamSSLFlags</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<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</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-tcp-stream-ssl-new-raw"></a><h3>camel_tcp_stream_ssl_new_raw ()</h3>
<pre class="programlisting"><a class="link" href="CamelStream.html" title="CamelStream"><span class="returnvalue">CamelStream</span></a> * camel_tcp_stream_ssl_new_raw (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *expected_host</code></em>,
<em class="parameter"><code><a class="link" href="camel-CamelTcpStreamSSL.html#CamelTcpStreamSSLFlags" title="enum CamelTcpStreamSSLFlags"><span class="type">CamelTcpStreamSSLFlags</span></a> flags</code></em>);</pre>
<p>
Since the SSL certificate authenticator may need to prompt the
user, a CamelSession is needed. <em class="parameter"><code>expected_host</code></em> is needed as a
protection against an MITM attack.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>an active <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>expected_host</code></em> :</span></p></td>
<td>host that the stream is expected to connect with</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
<td>a bitwise combination of <a class="link" href="camel-CamelTcpStreamSSL.html#CamelTcpStreamSSLFlags" title="enum CamelTcpStreamSSLFlags"><span class="type">CamelTcpStreamSSLFlags</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<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</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-tcp-stream-ssl-enable-ssl"></a><h3>camel_tcp_stream_ssl_enable_ssl ()</h3>
<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>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Toggles an ssl-capable stream into ssl mode (if it isn't already).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ssl</code></em> :</span></p></td>
<td>a <a class="link" href="camel-CamelTcpStreamSSL.html#CamelTcpStreamSSL" title="struct CamelTcpStreamSSL"><span class="type">CamelTcpStreamSSL</span></a> object</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">0</code> on success or <code class="literal">-1</code> on fail</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|