/usr/share/gtk-doc/html/loudmouth/loudmouth-lm-ssl.html is in libloudmouth1-dev 1.4.3-10.
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 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>LmSSL</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Loudmouth Reference Manual">
<link rel="up" href="ch01.html" title="Loudmouth">
<link rel="prev" href="loudmouth-lm-message-node.html" title="LmMessageNode">
<link rel="next" href="loudmouth-lm-proxy.html" title="LmProxy">
<meta name="generator" content="GTK-Doc V1.19 (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="loudmouth-lm-message-node.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.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">Loudmouth Reference Manual</th>
<td><a accesskey="n" href="loudmouth-lm-proxy.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#loudmouth-lm-ssl.synopsis" class="shortcut">Top</a>
|
<a href="#loudmouth-lm-ssl.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="loudmouth-lm-ssl"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="loudmouth-lm-ssl.top_of_page"></a>LmSSL</span></h2>
<p>LmSSL — SSL struct for SSL support in Loudmouth</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="loudmouth-lm-ssl.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="loudmouth-lm-ssl.html#LmSSL" title="LmSSL">LmSSL</a>;
enum <a class="link" href="loudmouth-lm-ssl.html#LmCertificateStatus" title="enum LmCertificateStatus">LmCertificateStatus</a>;
enum <a class="link" href="loudmouth-lm-ssl.html#LmSSLStatus" title="enum LmSSLStatus">LmSSLStatus</a>;
enum <a class="link" href="loudmouth-lm-ssl.html#LmSSLResponse" title="enum LmSSLResponse">LmSSLResponse</a>;
<a class="link" href="loudmouth-lm-ssl.html#LmSSLResponse" title="enum LmSSLResponse"><span class="returnvalue">LmSSLResponse</span></a> (<a class="link" href="loudmouth-lm-ssl.html#LmSSLFunction" title="LmSSLFunction ()">*LmSSLFunction</a>) (<em class="parameter"><code><a class="link" href="loudmouth-lm-ssl.html#LmSSL" title="LmSSL"><span class="type">LmSSL</span></a> *ssl</code></em>,
<em class="parameter"><code><a class="link" href="loudmouth-lm-ssl.html#LmSSLStatus" title="enum LmSSLStatus"><span class="type">LmSSLStatus</span></a> status</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
<a class="link" href="loudmouth-lm-ssl.html#LmSSL" title="LmSSL"><span class="returnvalue">LmSSL</span></a> * <a class="link" href="loudmouth-lm-ssl.html#lm-ssl-new" title="lm_ssl_new ()">lm_ssl_new</a> (<em class="parameter"><code>const <span class="type">gchar</span> *expected_fingerprint</code></em>,
<em class="parameter"><code><a class="link" href="loudmouth-lm-ssl.html#LmSSLFunction" title="LmSSLFunction ()"><span class="type">LmSSLFunction</span></a> ssl_function</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
<em class="parameter"><code><span class="type">GDestroyNotify</span> notify</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="loudmouth-lm-ssl.html#lm-ssl-is-supported" title="lm_ssl_is_supported ()">lm_ssl_is_supported</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="loudmouth-lm-ssl.html#lm-ssl-get-fingerprint" title="lm_ssl_get_fingerprint ()">lm_ssl_get_fingerprint</a> (<em class="parameter"><code><a class="link" href="loudmouth-lm-ssl.html#LmSSL" title="LmSSL"><span class="type">LmSSL</span></a> *ssl</code></em>);
<span class="returnvalue">void</span> <a class="link" href="loudmouth-lm-ssl.html#lm-ssl-use-starttls" title="lm_ssl_use_starttls ()">lm_ssl_use_starttls</a> (<em class="parameter"><code><a class="link" href="loudmouth-lm-ssl.html#LmSSL" title="LmSSL"><span class="type">LmSSL</span></a> *ssl</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> use_starttls</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> require_starttls</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="loudmouth-lm-ssl.html#lm-ssl-get-use-starttls" title="lm_ssl_get_use_starttls ()">lm_ssl_get_use_starttls</a> (<em class="parameter"><code><a class="link" href="loudmouth-lm-ssl.html#LmSSL" title="LmSSL"><span class="type">LmSSL</span></a> *ssl</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="loudmouth-lm-ssl.html#lm-ssl-get-require-starttls" title="lm_ssl_get_require_starttls ()">lm_ssl_get_require_starttls</a> (<em class="parameter"><code><a class="link" href="loudmouth-lm-ssl.html#LmSSL" title="LmSSL"><span class="type">LmSSL</span></a> *ssl</code></em>);
<a class="link" href="loudmouth-lm-ssl.html#LmSSL" title="LmSSL"><span class="returnvalue">LmSSL</span></a> * <a class="link" href="loudmouth-lm-ssl.html#lm-ssl-ref" title="lm_ssl_ref ()">lm_ssl_ref</a> (<em class="parameter"><code><a class="link" href="loudmouth-lm-ssl.html#LmSSL" title="LmSSL"><span class="type">LmSSL</span></a> *ssl</code></em>);
<span class="returnvalue">void</span> <a class="link" href="loudmouth-lm-ssl.html#lm-ssl-unref" title="lm_ssl_unref ()">lm_ssl_unref</a> (<em class="parameter"><code><a class="link" href="loudmouth-lm-ssl.html#LmSSL" title="LmSSL"><span class="type">LmSSL</span></a> *ssl</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="loudmouth-lm-ssl.description"></a><h2>Description</h2>
<p>
Use this together with an <a class="link" href="loudmouth-lm-connection.html#LmConnection" title="LmConnection"><span class="type">LmConnection</span></a> to get the connection to use SSL. Example of how to use the <a class="link" href="loudmouth-lm-ssl.html#LmSSL" title="LmSSL"><span class="type">LmSSL</span></a> API.
</p>
<div class="informalexample"><pre class="programlisting">
LmConnection *connection;
LmSSL *ssl;
connection = lm_connection_new ("myserver");
ssl = lm_ssl_new (NULL, my_ssl_func, NULL, NULL);
lm_connection_set_ssl (connection, ssl);
...
</pre></div>
</div>
<div class="refsect1">
<a name="loudmouth-lm-ssl.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="LmSSL"></a><h3>LmSSL</h3>
<pre class="programlisting">typedef struct _LmSSL LmSSL;</pre>
<p>
This should not be accessed directly. Use the accessor functions as described below.
</p>
</div>
<hr>
<div class="refsect2">
<a name="LmCertificateStatus"></a><h3>enum LmCertificateStatus</h3>
<pre class="programlisting">typedef enum {
LM_CERT_INVALID,
LM_CERT_ISSUER_NOT_FOUND,
LM_CERT_REVOKED
} LmCertificateStatus;
</pre>
<p>
Provides information of the status of a certain certificate.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="LM-CERT-INVALID:CAPS"></a><span class="term"><code class="literal">LM_CERT_INVALID</code></span></p></td>
<td>The certificate is invalid.
</td>
</tr>
<tr>
<td><p><a name="LM-CERT-ISSUER-NOT-FOUND:CAPS"></a><span class="term"><code class="literal">LM_CERT_ISSUER_NOT_FOUND</code></span></p></td>
<td>The issuer of the certificate is not found.
</td>
</tr>
<tr>
<td><p><a name="LM-CERT-REVOKED:CAPS"></a><span class="term"><code class="literal">LM_CERT_REVOKED</code></span></p></td>
<td>The certificate has been revoked.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="LmSSLStatus"></a><h3>enum LmSSLStatus</h3>
<pre class="programlisting">typedef enum {
LM_SSL_STATUS_NO_CERT_FOUND,
LM_SSL_STATUS_UNTRUSTED_CERT,
LM_SSL_STATUS_CERT_EXPIRED,
LM_SSL_STATUS_CERT_NOT_ACTIVATED,
LM_SSL_STATUS_CERT_HOSTNAME_MISMATCH,
LM_SSL_STATUS_CERT_FINGERPRINT_MISMATCH,
LM_SSL_STATUS_GENERIC_ERROR
} LmSSLStatus;
</pre>
<p>
Provides information about something gone wrong when trying to setup the SSL connection.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="LM-SSL-STATUS-NO-CERT-FOUND:CAPS"></a><span class="term"><code class="literal">LM_SSL_STATUS_NO_CERT_FOUND</code></span></p></td>
<td>The server doesn't provide a certificate.
</td>
</tr>
<tr>
<td><p><a name="LM-SSL-STATUS-UNTRUSTED-CERT:CAPS"></a><span class="term"><code class="literal">LM_SSL_STATUS_UNTRUSTED_CERT</code></span></p></td>
<td>The certification can not be trusted.
</td>
</tr>
<tr>
<td><p><a name="LM-SSL-STATUS-CERT-EXPIRED:CAPS"></a><span class="term"><code class="literal">LM_SSL_STATUS_CERT_EXPIRED</code></span></p></td>
<td>The certificate has expired.
</td>
</tr>
<tr>
<td><p><a name="LM-SSL-STATUS-CERT-NOT-ACTIVATED:CAPS"></a><span class="term"><code class="literal">LM_SSL_STATUS_CERT_NOT_ACTIVATED</code></span></p></td>
<td>The certificate has not been activated.
</td>
</tr>
<tr>
<td><p><a name="LM-SSL-STATUS-CERT-HOSTNAME-MISMATCH:CAPS"></a><span class="term"><code class="literal">LM_SSL_STATUS_CERT_HOSTNAME_MISMATCH</code></span></p></td>
<td>The server hostname doesn't match the one in the certificate.
</td>
</tr>
<tr>
<td><p><a name="LM-SSL-STATUS-CERT-FINGERPRINT-MISMATCH:CAPS"></a><span class="term"><code class="literal">LM_SSL_STATUS_CERT_FINGERPRINT_MISMATCH</code></span></p></td>
<td>The fingerprint doesn't match your expected.
</td>
</tr>
<tr>
<td><p><a name="LM-SSL-STATUS-GENERIC-ERROR:CAPS"></a><span class="term"><code class="literal">LM_SSL_STATUS_GENERIC_ERROR</code></span></p></td>
<td>Some other error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="LmSSLResponse"></a><h3>enum LmSSLResponse</h3>
<pre class="programlisting">typedef enum {
LM_SSL_RESPONSE_CONTINUE,
LM_SSL_RESPONSE_STOP
} LmSSLResponse;
</pre>
<p>
Used to inform <a class="link" href="loudmouth-lm-connection.html#LmConnection" title="LmConnection"><span class="type">LmConnection</span></a> if you want to stop due to an error reported or if you want to continue to connect.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="LM-SSL-RESPONSE-CONTINUE:CAPS"></a><span class="term"><code class="literal">LM_SSL_RESPONSE_CONTINUE</code></span></p></td>
<td>Continue to connect.
</td>
</tr>
<tr>
<td><p><a name="LM-SSL-RESPONSE-STOP:CAPS"></a><span class="term"><code class="literal">LM_SSL_RESPONSE_STOP</code></span></p></td>
<td>Stop the connection.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="LmSSLFunction"></a><h3>LmSSLFunction ()</h3>
<pre class="programlisting"><a class="link" href="loudmouth-lm-ssl.html#LmSSLResponse" title="enum LmSSLResponse"><span class="returnvalue">LmSSLResponse</span></a> (*LmSSLFunction) (<em class="parameter"><code><a class="link" href="loudmouth-lm-ssl.html#LmSSL" title="LmSSL"><span class="type">LmSSL</span></a> *ssl</code></em>,
<em class="parameter"><code><a class="link" href="loudmouth-lm-ssl.html#LmSSLStatus" title="enum LmSSLStatus"><span class="type">LmSSLStatus</span></a> status</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>
This function is called if something goes wrong during the connecting phase.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ssl</code></em> :</span></p></td>
<td>An <a class="link" href="loudmouth-lm-ssl.html#LmSSL" title="LmSSL"><span class="type">LmSSL</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td>
<td>The status informing what went wrong.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>User data provided in the callback.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>User should return <a class="link" href="loudmouth-lm-ssl.html#LM-SSL-RESPONSE-CONTINUE:CAPS"><span class="type">LM_SSL_RESPONSE_CONTINUE</span></a> if connection should proceed and otherwise <a class="link" href="loudmouth-lm-ssl.html#LM-SSL-RESPONSE-STOP:CAPS"><span class="type">LM_SSL_RESPONSE_STOP</span></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="lm-ssl-new"></a><h3>lm_ssl_new ()</h3>
<pre class="programlisting"><a class="link" href="loudmouth-lm-ssl.html#LmSSL" title="LmSSL"><span class="returnvalue">LmSSL</span></a> * lm_ssl_new (<em class="parameter"><code>const <span class="type">gchar</span> *expected_fingerprint</code></em>,
<em class="parameter"><code><a class="link" href="loudmouth-lm-ssl.html#LmSSLFunction" title="LmSSLFunction ()"><span class="type">LmSSLFunction</span></a> ssl_function</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
<em class="parameter"><code><span class="type">GDestroyNotify</span> notify</code></em>);</pre>
<p>
Creates a new SSL struct, call <a class="link" href="loudmouth-lm-connection.html#lm-connection-set-ssl" title="lm_connection_set_ssl ()"><span class="type">lm_connection_set_ssl</span></a> to use it.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>expected_fingerprint</code></em> :</span></p></td>
<td>The expected fingerprint. <em class="parameter"><code>ssl_function</code></em> will be called if there is a mismatch. <code class="literal">NULL</code> if you are not interested in this check.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ssl_function</code></em> :</span></p></td>
<td>Callback called to inform the user of a problem during setting up the SSL connection and how to proceed. If <code class="literal">NULL</code> is passed the default function that always continues will be used.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>Data sent with the callback.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>notify</code></em> :</span></p></td>
<td>Function to free <em class="parameter"><code>user_dataa</code></em> when the connection is finished. <code class="literal">NULL</code> if <em class="parameter"><code>user_data</code></em> should not be freed.</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="loudmouth-lm-ssl.html#LmSSL" title="LmSSL"><span class="type">LmSSL</span></a> struct.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="lm-ssl-is-supported"></a><h3>lm_ssl_is_supported ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> lm_ssl_is_supported (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Checks whether Loudmouth supports SSL or not.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if this installation of Loudmouth supports SSL, otherwise returns <span class="type">FALSE</span>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="lm-ssl-get-fingerprint"></a><h3>lm_ssl_get_fingerprint ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * lm_ssl_get_fingerprint (<em class="parameter"><code><a class="link" href="loudmouth-lm-ssl.html#LmSSL" title="LmSSL"><span class="type">LmSSL</span></a> *ssl</code></em>);</pre>
<p>
Returns the MD5 fingerprint of the remote server's certificate.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ssl</code></em> :</span></p></td>
<td>an <a class="link" href="loudmouth-lm-ssl.html#LmSSL" title="LmSSL"><span class="type">LmSSL</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A 16-byte array representing the fingerprint or <code class="literal">NULL</code> if unknown.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="lm-ssl-use-starttls"></a><h3>lm_ssl_use_starttls ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> lm_ssl_use_starttls (<em class="parameter"><code><a class="link" href="loudmouth-lm-ssl.html#LmSSL" title="LmSSL"><span class="type">LmSSL</span></a> *ssl</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> use_starttls</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> require_starttls</code></em>);</pre>
<p>
Set whether STARTTLS should be used.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ssl</code></em> :</span></p></td>
<td>an <a class="link" href="loudmouth-lm-ssl.html#LmSSL" title="LmSSL"><span class="type">LmSSL</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>use_starttls</code></em> :</span></p></td>
<td>
<span class="type">TRUE</span> if STARTTLS should be used.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>require_starttls</code></em> :</span></p></td>
<td>
<span class="type">TRUE</span> if STARTTLS should be required.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="lm-ssl-get-use-starttls"></a><h3>lm_ssl_get_use_starttls ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> lm_ssl_get_use_starttls (<em class="parameter"><code><a class="link" href="loudmouth-lm-ssl.html#LmSSL" title="LmSSL"><span class="type">LmSSL</span></a> *ssl</code></em>);</pre>
<p>
Fetches whether STARTTLS is used.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ssl</code></em> :</span></p></td>
<td>an <a class="link" href="loudmouth-lm-ssl.html#LmSSL" title="LmSSL"><span class="type">LmSSL</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> is <em class="parameter"><code>ssl</code></em> is configured to use STARTTLS.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="lm-ssl-get-require-starttls"></a><h3>lm_ssl_get_require_starttls ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> lm_ssl_get_require_starttls (<em class="parameter"><code><a class="link" href="loudmouth-lm-ssl.html#LmSSL" title="LmSSL"><span class="type">LmSSL</span></a> *ssl</code></em>);</pre>
<p>
Fetches whether STARTTLS is required.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ssl</code></em> :</span></p></td>
<td>an <a class="link" href="loudmouth-lm-ssl.html#LmSSL" title="LmSSL"><span class="type">LmSSL</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if <em class="parameter"><code>ssl</code></em> requires that STARTTLS succeed.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="lm-ssl-ref"></a><h3>lm_ssl_ref ()</h3>
<pre class="programlisting"><a class="link" href="loudmouth-lm-ssl.html#LmSSL" title="LmSSL"><span class="returnvalue">LmSSL</span></a> * lm_ssl_ref (<em class="parameter"><code><a class="link" href="loudmouth-lm-ssl.html#LmSSL" title="LmSSL"><span class="type">LmSSL</span></a> *ssl</code></em>);</pre>
<p>
Adds a reference to <em class="parameter"><code>ssl</code></em>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ssl</code></em> :</span></p></td>
<td>an <a class="link" href="loudmouth-lm-ssl.html#LmSSL" title="LmSSL"><span class="type">LmSSL</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the ssl</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="lm-ssl-unref"></a><h3>lm_ssl_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> lm_ssl_unref (<em class="parameter"><code><a class="link" href="loudmouth-lm-ssl.html#LmSSL" title="LmSSL"><span class="type">LmSSL</span></a> *ssl</code></em>);</pre>
<p>
Removes a reference from <em class="parameter"><code>ssl</code></em>. When no more references are present
<em class="parameter"><code>ssl</code></em> is freed.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>ssl</code></em> :</span></p></td>
<td>an <a class="link" href="loudmouth-lm-ssl.html#LmSSL" title="LmSSL"><span class="type">LmSSL</span></a>
</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|