mbedtls ported to mbed-classic

Fork of mbedtls by Christopher Haster

Embed: (wiki syntax)

« Back to documentation index

threading.h File Reference

threading.h File Reference

Threading abstraction layer. More...

Go to the source code of this file.

Functions

void mbedtls_threading_set_alt (void(*mutex_init)(mbedtls_threading_mutex_t *), void(*mutex_free)(mbedtls_threading_mutex_t *), int(*mutex_lock)(mbedtls_threading_mutex_t *), int(*mutex_unlock)(mbedtls_threading_mutex_t *))
 Set your alternate threading implementation function pointers and initialize global mutexes.
void mbedtls_threading_free_alt (void)
 Free global mutexes.

Detailed Description

Threading abstraction layer.

Copyright (C) 2006-2015, ARM Limited, All Rights Reserved SPDX-License-Identifier: Apache-2.0

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

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

Definition in file threading.h.


Function Documentation

void mbedtls_threading_free_alt ( void   )

Free global mutexes.

Definition at line 120 of file threading.c.

void mbedtls_threading_set_alt ( void(*)(mbedtls_threading_mutex_t *)  mutex_init,
void(*)(mbedtls_threading_mutex_t *)  mutex_free,
int(*)(mbedtls_threading_mutex_t *)  mutex_lock,
int(*)(mbedtls_threading_mutex_t *)  mutex_unlock 
)

Set your alternate threading implementation function pointers and initialize global mutexes.

If used, this function must be called once in the main thread before any other mbed TLS function is called, and mbedtls_threading_free_alt() must be called once in the main thread after all other mbed TLS functions.

Note:
mutex_init() and mutex_free() don't return a status code. If mutex_init() fails, it should leave its argument (the mutex) in a state such that mutex_lock() will fail when called with this argument.
Parameters:
mutex_initthe init function implementation
mutex_freethe free function implementation
mutex_lockthe lock function implementation
mutex_unlockthe unlock function implementation

Definition at line 103 of file threading.c.