mbed TLS library

Dependents:   HTTPClient-SSL WS_SERVER

Embed: (wiki syntax)

« Back to documentation index

ssl_cache.h File Reference

ssl_cache.h File Reference

SSL session cache implementation. More...

Go to the source code of this file.

Data Structures

struct  _ssl_cache_entry
 This structure is used for storing cache entries. More...
struct  _ssl_cache_context
 Cache context. More...

Functions

void ssl_cache_init (ssl_cache_context *cache)
 Initialize an SSL cache context.
int ssl_cache_get (void *data, ssl_session *session)
 Cache get callback implementation (Thread-safe if POLARSSL_THREADING_C is enabled)
int ssl_cache_set (void *data, const ssl_session *session)
 Cache set callback implementation (Thread-safe if POLARSSL_THREADING_C is enabled)
void ssl_cache_set_timeout (ssl_cache_context *cache, int timeout)
 Set the cache timeout (Default: SSL_CACHE_DEFAULT_TIMEOUT (1 day))
void ssl_cache_set_max_entries (ssl_cache_context *cache, int max)
 Set the cache timeout (Default: SSL_CACHE_DEFAULT_MAX_ENTRIES (50))
void ssl_cache_free (ssl_cache_context *cache)
 Free referenced items in a cache context and clear memory.

Detailed Description

SSL session cache implementation.

Copyright (C) 2006-2013, ARM Limited, All Rights Reserved

This file is part of mbed TLS (https://tls.mbed.org)

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.

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.

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.

Definition in file ssl_cache.h.


Function Documentation

void ssl_cache_free ( ssl_cache_context cache )

Free referenced items in a cache context and clear memory.

Parameters:
cacheSSL cache context

Definition at line 304 of file ssl_cache.c.

int ssl_cache_get ( void *  data,
ssl_session *  session 
)

Cache get callback implementation (Thread-safe if POLARSSL_THREADING_C is enabled)

Parameters:
dataSSL cache context
sessionsession to retrieve entry for

Definition at line 59 of file ssl_cache.c.

void ssl_cache_init ( ssl_cache_context cache )

Initialize an SSL cache context.

Parameters:
cacheSSL cache context

Definition at line 47 of file ssl_cache.c.

int ssl_cache_set ( void *  data,
const ssl_session *  session 
)

Cache set callback implementation (Thread-safe if POLARSSL_THREADING_C is enabled)

Parameters:
dataSSL cache context
sessionsession to store entry for

Definition at line 138 of file ssl_cache.c.

void ssl_cache_set_max_entries ( ssl_cache_context cache,
int  max 
)

Set the cache timeout (Default: SSL_CACHE_DEFAULT_MAX_ENTRIES (50))

Parameters:
cacheSSL cache context
maxcache entry maximum

Definition at line 297 of file ssl_cache.c.

void ssl_cache_set_timeout ( ssl_cache_context cache,
int  timeout 
)

Set the cache timeout (Default: SSL_CACHE_DEFAULT_TIMEOUT (1 day))

A timeout of 0 indicates no timeout.

Parameters:
cacheSSL cache context
timeoutcache entry timeout in seconds

Definition at line 289 of file ssl_cache.c.