<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mbed TLS v2.7.3: ssl_cache.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">mbed TLS v2.7.3
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_b4d146e9a6d8dd56ed4afb2480a97fd3.html">mbedtls</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">ssl_cache.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>SSL session cache implementation.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "<a class="el" href="ssl_8h_source.html">ssl.h</a>"</code><br />
<code>#include "<a class="el" href="threading_8h_source.html">threading.h</a>"</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for ssl_cache.h:</div>
<div class="dyncontent">
<div class="center"><img src="ssl__cache_8h__incl.png" border="0" usemap="#ssl__cache_8h" alt=""/></div>
<map name="ssl__cache_8h" id="ssl__cache_8h">
</map>
</div>
</div>
<p><a href="ssl__cache_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structmbedtls__ssl__cache__entry.html">mbedtls_ssl_cache_entry</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">This structure is used for storing cache entries. <a href="structmbedtls__ssl__cache__entry.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structmbedtls__ssl__cache__context.html">mbedtls_ssl_cache_context</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Cache context. <a href="structmbedtls__ssl__cache__context.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">SECTION: Module settings</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>The configuration options you can set for this module are in this section. Either change them in <a class="el" href="config_8h.html" title="Configuration options (set of defines) ">config.h</a> or define them on the compiler command line. </p>
</div></td></tr>
<tr class="memitem:a02b027cfb82a0436a19bfeada16cb8db"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ssl__cache_8h.html#a02b027cfb82a0436a19bfeada16cb8db">MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT</a>   86400</td></tr>
<tr class="separator:a02b027cfb82a0436a19bfeada16cb8db"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a03256bf3d0f0c370d6984b441b86567e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ssl__cache_8h.html#a03256bf3d0f0c370d6984b441b86567e">MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES</a>   50</td></tr>
<tr class="separator:a03256bf3d0f0c370d6984b441b86567e"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a9abd00554287df218aa9c3b035a2037a"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structmbedtls__ssl__cache__context.html">mbedtls_ssl_cache_context</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ssl__cache_8h.html#a9abd00554287df218aa9c3b035a2037a">mbedtls_ssl_cache_context</a></td></tr>
<tr class="separator:a9abd00554287df218aa9c3b035a2037a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a332c11cba2ba38db69b96458551da577"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structmbedtls__ssl__cache__entry.html">mbedtls_ssl_cache_entry</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ssl__cache_8h.html#a332c11cba2ba38db69b96458551da577">mbedtls_ssl_cache_entry</a></td></tr>
<tr class="separator:a332c11cba2ba38db69b96458551da577"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a90886fd9ad56471c5ebaed2e05086cd5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ssl__cache_8h.html#a90886fd9ad56471c5ebaed2e05086cd5">mbedtls_ssl_cache_init</a> (<a class="el" href="structmbedtls__ssl__cache__context.html">mbedtls_ssl_cache_context</a> *cache)</td></tr>
<tr class="memdesc:a90886fd9ad56471c5ebaed2e05086cd5"><td class="mdescLeft"> </td><td class="mdescRight">Initialize an SSL cache context. <a href="#a90886fd9ad56471c5ebaed2e05086cd5">More...</a><br /></td></tr>
<tr class="separator:a90886fd9ad56471c5ebaed2e05086cd5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af0ab0006ecbbec9405be5566ac16c4b3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ssl__cache_8h.html#af0ab0006ecbbec9405be5566ac16c4b3">mbedtls_ssl_cache_get</a> (void *data, <a class="el" href="structmbedtls__ssl__session.html">mbedtls_ssl_session</a> *session)</td></tr>
<tr class="memdesc:af0ab0006ecbbec9405be5566ac16c4b3"><td class="mdescLeft"> </td><td class="mdescRight">Cache get callback implementation (Thread-safe if MBEDTLS_THREADING_C is enabled) <a href="#af0ab0006ecbbec9405be5566ac16c4b3">More...</a><br /></td></tr>
<tr class="separator:af0ab0006ecbbec9405be5566ac16c4b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a896a81cf3107ba7464e6273970c2c1eb"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ssl__cache_8h.html#a896a81cf3107ba7464e6273970c2c1eb">mbedtls_ssl_cache_set</a> (void *data, const <a class="el" href="structmbedtls__ssl__session.html">mbedtls_ssl_session</a> *session)</td></tr>
<tr class="memdesc:a896a81cf3107ba7464e6273970c2c1eb"><td class="mdescLeft"> </td><td class="mdescRight">Cache set callback implementation (Thread-safe if MBEDTLS_THREADING_C is enabled) <a href="#a896a81cf3107ba7464e6273970c2c1eb">More...</a><br /></td></tr>
<tr class="separator:a896a81cf3107ba7464e6273970c2c1eb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa3468c4ebd9484227436014db30b8f5f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ssl__cache_8h.html#aa3468c4ebd9484227436014db30b8f5f">mbedtls_ssl_cache_set_timeout</a> (<a class="el" href="structmbedtls__ssl__cache__context.html">mbedtls_ssl_cache_context</a> *cache, int timeout)</td></tr>
<tr class="memdesc:aa3468c4ebd9484227436014db30b8f5f"><td class="mdescLeft"> </td><td class="mdescRight">Set the cache timeout (Default: MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT (1 day)) <a href="#aa3468c4ebd9484227436014db30b8f5f">More...</a><br /></td></tr>
<tr class="separator:aa3468c4ebd9484227436014db30b8f5f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abc39c23cf3f791359104d9094bd9cf6f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ssl__cache_8h.html#abc39c23cf3f791359104d9094bd9cf6f">mbedtls_ssl_cache_set_max_entries</a> (<a class="el" href="structmbedtls__ssl__cache__context.html">mbedtls_ssl_cache_context</a> *cache, int max)</td></tr>
<tr class="memdesc:abc39c23cf3f791359104d9094bd9cf6f"><td class="mdescLeft"> </td><td class="mdescRight">Set the maximum number of cache entries (Default: MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES (50)) <a href="#abc39c23cf3f791359104d9094bd9cf6f">More...</a><br /></td></tr>
<tr class="separator:abc39c23cf3f791359104d9094bd9cf6f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a93a35f5cd109f9d698bfac659905c0d8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ssl__cache_8h.html#a93a35f5cd109f9d698bfac659905c0d8">mbedtls_ssl_cache_free</a> (<a class="el" href="structmbedtls__ssl__cache__context.html">mbedtls_ssl_cache_context</a> *cache)</td></tr>
<tr class="memdesc:a93a35f5cd109f9d698bfac659905c0d8"><td class="mdescLeft"> </td><td class="mdescRight">Free referenced items in a cache context and clear memory. <a href="#a93a35f5cd109f9d698bfac659905c0d8">More...</a><br /></td></tr>
<tr class="separator:a93a35f5cd109f9d698bfac659905c0d8"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>SSL session cache implementation. </p>
<p class="definition">Definition in file <a class="el" href="ssl__cache_8h_source.html">ssl_cache.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a03256bf3d0f0c370d6984b441b86567e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03256bf3d0f0c370d6984b441b86567e">◆ </a></span>MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES   50</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum entries in cache </p>
<p class="definition">Definition at line <a class="el" href="ssl__cache_8h_source.html#l00046">46</a> of file <a class="el" href="ssl__cache_8h_source.html">ssl_cache.h</a>.</p>
</div>
</div>
<a id="a02b027cfb82a0436a19bfeada16cb8db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a02b027cfb82a0436a19bfeada16cb8db">◆ </a></span>MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT   86400</td>
</tr>
</table>
</div><div class="memdoc">
<p>1 day </p>
<p class="definition">Definition at line <a class="el" href="ssl__cache_8h_source.html#l00042">42</a> of file <a class="el" href="ssl__cache_8h_source.html">ssl_cache.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a9abd00554287df218aa9c3b035a2037a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9abd00554287df218aa9c3b035a2037a">◆ </a></span>mbedtls_ssl_cache_context</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structmbedtls__ssl__cache__context.html">mbedtls_ssl_cache_context</a> <a class="el" href="structmbedtls__ssl__cache__context.html">mbedtls_ssl_cache_context</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ssl__cache_8h_source.html#l00055">55</a> of file <a class="el" href="ssl__cache_8h_source.html">ssl_cache.h</a>.</p>
</div>
</div>
<a id="a332c11cba2ba38db69b96458551da577"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a332c11cba2ba38db69b96458551da577">◆ </a></span>mbedtls_ssl_cache_entry</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structmbedtls__ssl__cache__entry.html">mbedtls_ssl_cache_entry</a> <a class="el" href="structmbedtls__ssl__cache__entry.html">mbedtls_ssl_cache_entry</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ssl__cache_8h_source.html#l00056">56</a> of file <a class="el" href="ssl__cache_8h_source.html">ssl_cache.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a93a35f5cd109f9d698bfac659905c0d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a93a35f5cd109f9d698bfac659905c0d8">◆ </a></span>mbedtls_ssl_cache_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mbedtls_ssl_cache_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmbedtls__ssl__cache__context.html">mbedtls_ssl_cache_context</a> * </td>
<td class="paramname"><em>cache</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free referenced items in a cache context and clear memory. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cache</td><td>SSL cache context </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af0ab0006ecbbec9405be5566ac16c4b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af0ab0006ecbbec9405be5566ac16c4b3">◆ </a></span>mbedtls_ssl_cache_get()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mbedtls_ssl_cache_get </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structmbedtls__ssl__session.html">mbedtls_ssl_session</a> * </td>
<td class="paramname"><em>session</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Cache get callback implementation (Thread-safe if MBEDTLS_THREADING_C is enabled) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>SSL cache context </td></tr>
<tr><td class="paramname">session</td><td>session to retrieve entry for </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a90886fd9ad56471c5ebaed2e05086cd5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a90886fd9ad56471c5ebaed2e05086cd5">◆ </a></span>mbedtls_ssl_cache_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mbedtls_ssl_cache_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmbedtls__ssl__cache__context.html">mbedtls_ssl_cache_context</a> * </td>
<td class="paramname"><em>cache</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize an SSL cache context. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cache</td><td>SSL cache context </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a896a81cf3107ba7464e6273970c2c1eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a896a81cf3107ba7464e6273970c2c1eb">◆ </a></span>mbedtls_ssl_cache_set()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mbedtls_ssl_cache_set </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structmbedtls__ssl__session.html">mbedtls_ssl_session</a> * </td>
<td class="paramname"><em>session</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Cache set callback implementation (Thread-safe if MBEDTLS_THREADING_C is enabled) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>SSL cache context </td></tr>
<tr><td class="paramname">session</td><td>session to store entry for </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="abc39c23cf3f791359104d9094bd9cf6f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abc39c23cf3f791359104d9094bd9cf6f">◆ </a></span>mbedtls_ssl_cache_set_max_entries()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mbedtls_ssl_cache_set_max_entries </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmbedtls__ssl__cache__context.html">mbedtls_ssl_cache_context</a> * </td>
<td class="paramname"><em>cache</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>max</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the maximum number of cache entries (Default: MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES (50)) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cache</td><td>SSL cache context </td></tr>
<tr><td class="paramname">max</td><td>cache entry maximum </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa3468c4ebd9484227436014db30b8f5f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3468c4ebd9484227436014db30b8f5f">◆ </a></span>mbedtls_ssl_cache_set_timeout()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mbedtls_ssl_cache_set_timeout </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmbedtls__ssl__cache__context.html">mbedtls_ssl_cache_context</a> * </td>
<td class="paramname"><em>cache</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>timeout</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the cache timeout (Default: MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT (1 day)) </p>
<p>A timeout of 0 indicates no timeout.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cache</td><td>SSL cache context </td></tr>
<tr><td class="paramname">timeout</td><td>cache entry timeout in seconds </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue May 8 2018 21:08:41 for mbed TLS v2.7.3 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
f835bee5b8b7ec08e20fae17cab51e63
>
files
>
471
