RTEMS: API Mutex Handler

| RTEMS 5.4-rc2

Loading...
Searching...
No Matches
Modules | Files | Data Structures | Macros | Functions
API Mutex Handler
Internal » SuperCore

Provides routines to ensure mutual exclusion on API level. More...

## Modules
| RTEMS Allocator Mutex
| Protection for all memory allocations and deallocations in RTEMS.

## Files
file | apimutex.h
| API Mutex Handler API.
file | muteximpl.h
| Structures for the implementation of mutexes.
file | apimutexisowner.c
file | apimutexlock.c
| Acquires the specified API mutex.
file | apimutexunlock.c
| Releases the Specified API Mutex.

## Data Structures
struct | API_Mutex_Control
| Control block used to manage each API mutex. More...
struct | Mutex_Control
struct | Mutex_recursive_Control

## Macros
#define | API_MUTEX_INITIALIZER(name) { _MUTEX_RECURSIVE_NAMED_INITIALIZER( name ), 0 }
| Statically initialize an API mutex.

## Functions
void | _API_Mutex_Lock (API_Mutex_Control *mutex)
| Acquires the specified API mutex.
void | _API_Mutex_Unlock (API_Mutex_Control *mutex)
| Releases the specified API mutex.
bool | _API_Mutex_Is_owner (const API_Mutex_Control *mutex)
| Checks if the specified API mutex is owned by the executing thread.

## Detailed Description

Provides routines to ensure mutual exclusion on API level.

## Function Documentation

## ◆ _API_Mutex_Is_owner()

bool _API_Mutex_Is_owner | ( | const API_Mutex_Control * | mutex | ) |

Checks if the specified API mutex is owned by the executing thread.

Parameters

  [in] | mutex | The API mutex to check the owner from.

## ◆ _API_Mutex_Lock()

void _API_Mutex_Lock | ( | API_Mutex_Control * | mutex | ) |

Acquires the specified API mutex.

Parameters

  [in,out] | mutex | The API mutex to acquire.

## ◆ _API_Mutex_Unlock()

void _API_Mutex_Unlock | ( | API_Mutex_Control * | mutex | ) |

Releases the specified API mutex.

Parameters

  [in,out] | mutex | The API mutex to release.