BA / Mbed OS BaBoRo1
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  mbedtls_ssl_cache_entry
 This structure is used for storing cache entries. More...
struct  mbedtls_ssl_cache_context
 Cache context. More...

Functions

void mbedtls_ssl_cache_init (mbedtls_ssl_cache_context *cache)
 Initialize an SSL cache context.
int mbedtls_ssl_cache_get (void *data, mbedtls_ssl_session *session)
 Cache get callback implementation (Thread-safe if MBEDTLS_THREADING_C is enabled)
int mbedtls_ssl_cache_set (void *data, const mbedtls_ssl_session *session)
 Cache set callback implementation (Thread-safe if MBEDTLS_THREADING_C is enabled)
void mbedtls_ssl_cache_set_timeout (mbedtls_ssl_cache_context *cache, int timeout)
 Set the cache timeout (Default: MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT (1 day))
void mbedtls_ssl_cache_set_max_entries (mbedtls_ssl_cache_context *cache, int max)
 Set the maximum number of cache entries (Default: MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES (50))
void mbedtls_ssl_cache_free (mbedtls_ssl_cache_context *cache)
 Free referenced items in a cache context and clear memory.

Detailed Description

SSL session cache implementation.

Definition in file ssl_cache.h.


Function Documentation

void mbedtls_ssl_cache_free ( mbedtls_ssl_cache_context cache )

Free referenced items in a cache context and clear memory.

Parameters:
cacheSSL cache context

Definition at line 301 of file ssl_cache.c.

int mbedtls_ssl_cache_get ( void *  data,
mbedtls_ssl_session *  session 
)

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

Parameters:
dataSSL cache context
sessionsession to retrieve entry for

Definition at line 58 of file ssl_cache.c.

void mbedtls_ssl_cache_init ( mbedtls_ssl_cache_context cache )

Initialize an SSL cache context.

Parameters:
cacheSSL cache context

Definition at line 46 of file ssl_cache.c.

int mbedtls_ssl_cache_set ( void *  data,
const mbedtls_ssl_session *  session 
)

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

Parameters:
dataSSL cache context
sessionsession to store entry for

Definition at line 137 of file ssl_cache.c.

void mbedtls_ssl_cache_set_max_entries ( mbedtls_ssl_cache_context cache,
int  max 
)

Set the maximum number of cache entries (Default: MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES (50))

Parameters:
cacheSSL cache context
maxcache entry maximum

Definition at line 294 of file ssl_cache.c.

void mbedtls_ssl_cache_set_timeout ( mbedtls_ssl_cache_context cache,
int  timeout 
)

Set the cache timeout (Default: MBEDTLS_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 286 of file ssl_cache.c.