RTEMS 6.1-rc4
Loading...
Searching...
No Matches
Modules | Files | Data Structures | Macros | Functions
API Mutex Handler

This group contains the API Mutex Handler implementation. More...

Modules

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

Files

file  apimutex.h
 This header file provides the interfaces of the API Mutex Handler.
 
file  allocatormutex.c
 This source file contains the implementation of _RTEMS_Lock_allocator(), _RTEMS_Unlock_allocator(), and _RTEMS_Allocator_is_owner().
 
file  apimutexisowner.c
 This source file contains the implementation of _API_Mutex_Is_owner().
 
file  apimutexlock.c
 This source file contains the implementation of _API_Mutex_Lock().
 
file  apimutexunlock.c
 This source file contains the implementation of _API_Mutex_Unlock().
 

Data Structures

struct  API_Mutex_Control
 Control block used to manage each API mutex. More...
 

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

This group contains the API Mutex Handler implementation.

This handler provides routines to ensure mutual exclusion in a thread context at the 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]mutexThe 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]mutexThe API mutex to acquire.

◆ _API_Mutex_Unlock()

void _API_Mutex_Unlock ( API_Mutex_Control mutex)

Releases the specified API mutex.

Parameters
[in,out]mutexThe API mutex to release.