<!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.5"/>
<title>PolarSSL v1.3.8: 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 style="padding-left: 0.5em;">
<div id="projectname">PolarSSL v1.3.8
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_6a9bbd12bf4e19a18c45e270f8fae3fd.html">include</a></li><li class="navelem"><a class="el" href="dir_04272d44da4745cf8b8bfc767d6c6523.html">polarssl</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/>
</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="struct__ssl__cache__entry.html">_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="struct__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="struct__ssl__cache__context.html">_ssl_cache_context</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Cache context. <a href="struct__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.</p>
<p>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:a77f926737350e8e702a8323fee6abc90"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ssl__cache_8h.html#a77f926737350e8e702a8323fee6abc90">SSL_CACHE_DEFAULT_TIMEOUT</a>   86400</td></tr>
<tr class="separator:a77f926737350e8e702a8323fee6abc90"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad90e356ca9b417005065a25871b6bd07"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ssl__cache_8h.html#ad90e356ca9b417005065a25871b6bd07">SSL_CACHE_DEFAULT_MAX_ENTRIES</a>   50</td></tr>
<tr class="separator:ad90e356ca9b417005065a25871b6bd07"><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:a5ea4a9067ba1f6748e55ff4e24a76dc2"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct__ssl__cache__context.html">_ssl_cache_context</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ssl__cache_8h.html#a5ea4a9067ba1f6748e55ff4e24a76dc2">ssl_cache_context</a></td></tr>
<tr class="separator:a5ea4a9067ba1f6748e55ff4e24a76dc2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aef87b89b5b33356cc12e0e3c5e482407"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct__ssl__cache__entry.html">_ssl_cache_entry</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ssl__cache_8h.html#aef87b89b5b33356cc12e0e3c5e482407">ssl_cache_entry</a></td></tr>
<tr class="separator:aef87b89b5b33356cc12e0e3c5e482407"><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:a02ffd9b13eee9ea9ec0a65a4a8c9a03a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ssl__cache_8h.html#a02ffd9b13eee9ea9ec0a65a4a8c9a03a">ssl_cache_init</a> (<a class="el" href="ssl__cache_8h.html#a5ea4a9067ba1f6748e55ff4e24a76dc2">ssl_cache_context</a> *cache)</td></tr>
<tr class="memdesc:a02ffd9b13eee9ea9ec0a65a4a8c9a03a"><td class="mdescLeft"> </td><td class="mdescRight">Initialize an SSL cache context. <a href="#a02ffd9b13eee9ea9ec0a65a4a8c9a03a">More...</a><br/></td></tr>
<tr class="separator:a02ffd9b13eee9ea9ec0a65a4a8c9a03a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a697c59bc8b5fe2c6b1372f393de0698d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ssl__cache_8h.html#a697c59bc8b5fe2c6b1372f393de0698d">ssl_cache_get</a> (void *data, <a class="el" href="ssl_8h.html#abb59b301c07806142c790115fa49eb9e">ssl_session</a> *session)</td></tr>
<tr class="memdesc:a697c59bc8b5fe2c6b1372f393de0698d"><td class="mdescLeft"> </td><td class="mdescRight">Cache get callback implementation (Thread-safe if POLARSSL_THREADING_C is enabled) <a href="#a697c59bc8b5fe2c6b1372f393de0698d">More...</a><br/></td></tr>
<tr class="separator:a697c59bc8b5fe2c6b1372f393de0698d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acdb215996a89789840abdd6f86cbe49e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ssl__cache_8h.html#acdb215996a89789840abdd6f86cbe49e">ssl_cache_set</a> (void *data, const <a class="el" href="ssl_8h.html#abb59b301c07806142c790115fa49eb9e">ssl_session</a> *session)</td></tr>
<tr class="memdesc:acdb215996a89789840abdd6f86cbe49e"><td class="mdescLeft"> </td><td class="mdescRight">Cache set callback implementation (Thread-safe if POLARSSL_THREADING_C is enabled) <a href="#acdb215996a89789840abdd6f86cbe49e">More...</a><br/></td></tr>
<tr class="separator:acdb215996a89789840abdd6f86cbe49e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a48bf4718c43a9a4692d4f231f2bd2d88"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ssl__cache_8h.html#a48bf4718c43a9a4692d4f231f2bd2d88">ssl_cache_set_timeout</a> (<a class="el" href="ssl__cache_8h.html#a5ea4a9067ba1f6748e55ff4e24a76dc2">ssl_cache_context</a> *cache, int timeout)</td></tr>
<tr class="memdesc:a48bf4718c43a9a4692d4f231f2bd2d88"><td class="mdescLeft"> </td><td class="mdescRight">Set the cache timeout (Default: SSL_CACHE_DEFAULT_TIMEOUT (1 day)) <a href="#a48bf4718c43a9a4692d4f231f2bd2d88">More...</a><br/></td></tr>
<tr class="separator:a48bf4718c43a9a4692d4f231f2bd2d88"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0b7a0cca4095b1e058ece62c6b7d7baa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ssl__cache_8h.html#a0b7a0cca4095b1e058ece62c6b7d7baa">ssl_cache_set_max_entries</a> (<a class="el" href="ssl__cache_8h.html#a5ea4a9067ba1f6748e55ff4e24a76dc2">ssl_cache_context</a> *cache, int max)</td></tr>
<tr class="memdesc:a0b7a0cca4095b1e058ece62c6b7d7baa"><td class="mdescLeft"> </td><td class="mdescRight">Set the cache timeout (Default: SSL_CACHE_DEFAULT_MAX_ENTRIES (50)) <a href="#a0b7a0cca4095b1e058ece62c6b7d7baa">More...</a><br/></td></tr>
<tr class="separator:a0b7a0cca4095b1e058ece62c6b7d7baa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5c2df860f7c31015e6e9804d49089583"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ssl__cache_8h.html#a5c2df860f7c31015e6e9804d49089583">ssl_cache_free</a> (<a class="el" href="ssl__cache_8h.html#a5ea4a9067ba1f6748e55ff4e24a76dc2">ssl_cache_context</a> *cache)</td></tr>
<tr class="memdesc:a5c2df860f7c31015e6e9804d49089583"><td class="mdescLeft"> </td><td class="mdescRight">Free referenced items in a cache context and clear memory. <a href="#a5c2df860f7c31015e6e9804d49089583">More...</a><br/></td></tr>
<tr class="separator:a5c2df860f7c31015e6e9804d49089583"><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>Copyright (C) 2006-2013, Brainspark B.V.</p>
<p>This file is part of PolarSSL (<a href="http://www.polarssl.org">http://www.polarssl.org</a>) Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org></p>
<p>All rights reserved.</p>
<p>This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.</p>
<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. </p>
<p>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 class="anchor" id="ad90e356ca9b417005065a25871b6bd07"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SSL_CACHE_DEFAULT_MAX_ENTRIES   50</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum entries in cache </p>
<p>Definition at line <a class="el" href="ssl__cache_8h_source.html#l00049">49</a> of file <a class="el" href="ssl__cache_8h_source.html">ssl_cache.h</a>.</p>
</div>
</div>
<a class="anchor" id="a77f926737350e8e702a8323fee6abc90"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SSL_CACHE_DEFAULT_TIMEOUT   86400</td>
</tr>
</table>
</div><div class="memdoc">
<p>1 day </p>
<p>Definition at line <a class="el" href="ssl__cache_8h_source.html#l00045">45</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 class="anchor" id="a5ea4a9067ba1f6748e55ff4e24a76dc2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="struct__ssl__cache__context.html">_ssl_cache_context</a> <a class="el" href="ssl__cache_8h.html#a5ea4a9067ba1f6748e55ff4e24a76dc2">ssl_cache_context</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="ssl__cache_8h_source.html#l00058">58</a> of file <a class="el" href="ssl__cache_8h_source.html">ssl_cache.h</a>.</p>
</div>
</div>
<a class="anchor" id="aef87b89b5b33356cc12e0e3c5e482407"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="struct__ssl__cache__entry.html">_ssl_cache_entry</a> <a class="el" href="ssl__cache_8h.html#aef87b89b5b33356cc12e0e3c5e482407">ssl_cache_entry</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="ssl__cache_8h_source.html#l00059">59</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 class="anchor" id="a5c2df860f7c31015e6e9804d49089583"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ssl_cache_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ssl__cache_8h.html#a5ea4a9067ba1f6748e55ff4e24a76dc2">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 class="anchor" id="a697c59bc8b5fe2c6b1372f393de0698d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int 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="ssl_8h.html#abb59b301c07806142c790115fa49eb9e">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 POLARSSL_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 class="anchor" id="a02ffd9b13eee9ea9ec0a65a4a8c9a03a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ssl_cache_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ssl__cache_8h.html#a5ea4a9067ba1f6748e55ff4e24a76dc2">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 class="anchor" id="acdb215996a89789840abdd6f86cbe49e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int 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="ssl_8h.html#abb59b301c07806142c790115fa49eb9e">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 POLARSSL_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 class="anchor" id="a0b7a0cca4095b1e058ece62c6b7d7baa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ssl_cache_set_max_entries </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ssl__cache_8h.html#a5ea4a9067ba1f6748e55ff4e24a76dc2">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 cache timeout (Default: 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 class="anchor" id="a48bf4718c43a9a4692d4f231f2bd2d88"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ssl_cache_set_timeout </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ssl__cache_8h.html#a5ea4a9067ba1f6748e55ff4e24a76dc2">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: SSL_CACHE_DEFAULT_TIMEOUT (1 day)) </p>
<pre class="fragment"> A timeout of 0 indicates no timeout.
</pre><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 Thu Jul 31 2014 11:35:56 for PolarSSL v1.3.8 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
