PSDK QNX API Guide
Files | Data Structures | Variables
MutexP
OSAL

Files

file  MutexP.h
 Mailbox module for the RTOS Porting Interface.
 

Data Structures

struct  MutexP_Object
 MutexP Mutex Object. More...
 

Variables

void * MutexP_Object::object
 
uintptr_t MutexP_Object::key
 

MutexP Status codes

typedef int32_t MutexP_Status
 This enumerator defines the Status codes for MutexP APIs. More...
 
typedef void * MutexP_Handle
 Opaque client reference to an instance of a MutexP. More...
 
MutexP_Handle MutexP_create (MutexP_Object *mutexObj)
 Function to create a mutex. More...
 
MutexP_Status MutexP_delete (MutexP_Handle handle)
 Function to delete a mutex. More...
 
MutexP_Status MutexP_unlock (MutexP_Handle handle)
 Function to unlock the mutex. More...
 
MutexP_Status MutexP_lock (MutexP_Handle handle, uint32_t timeout)
 Function to lock the mutex. More...
 
#define MutexP_OK   0
 
#define MutexP_FAILURE   (-(int32_t)1)
 
#define MutexP_TIMEOUT   (-(int32_t)2)
 
#define MutexP_WAIT_FOREVER   (~((uint32_t)0U))
 Wait forever define. More...
 
#define MutexP_NO_WAIT   ((uint32_t)0U)
 No wait define. More...
 

Detailed Description

MutexP interface

Macro Definition Documentation

◆ MutexP_OK

#define MutexP_OK   0

API completed successfully

◆ MutexP_FAILURE

#define MutexP_FAILURE   (-(int32_t)1)

API failed

◆ MutexP_TIMEOUT

#define MutexP_TIMEOUT   (-(int32_t)2)

API failed because of a timeout

◆ MutexP_WAIT_FOREVER

#define MutexP_WAIT_FOREVER   (~((uint32_t)0U))

Wait forever define.

◆ MutexP_NO_WAIT

#define MutexP_NO_WAIT   ((uint32_t)0U)

No wait define.

Typedef Documentation

◆ MutexP_Status

typedef int32_t MutexP_Status

This enumerator defines the Status codes for MutexP APIs.

◆ MutexP_Handle

typedef void* MutexP_Handle

Opaque client reference to an instance of a MutexP.

A MutexP_Handle returned from the MutexP_create represents that instance and is used in the other instance based functions

Function Documentation

◆ MutexP_create()

MutexP_Handle MutexP_create ( MutexP_Object *  mutexObj)

Function to create a mutex.

Parameters
mutexObjPointer to the mutex object
Returns
A MutexP_Handle on success or a NULL on an error

◆ MutexP_delete()

MutexP_Status MutexP_delete ( MutexP_Handle  handle)

Function to delete a mutex.

Parameters
handleA MutexP_Handle returned from MutexP_create
Returns
Status of the functions
  • MutexP_OK: Deleted the mutex instance
  • MutexP_FAILURE: Failed to delete the mutex instance

◆ MutexP_unlock()

MutexP_Status MutexP_unlock ( MutexP_Handle  handle)

Function to unlock the mutex.

Parameters
handleA MutexP_Handle returned from MutexP_create
Returns
Status of the functions
  • MutexP_OK: Unlocked the mutex
  • MutexP_FAILURE: Failed to unlock the mutex

◆ MutexP_lock()

MutexP_Status MutexP_lock ( MutexP_Handle  handle,
uint32_t  timeout 
)

Function to lock the mutex.

Parameters
handleA MutexP_Handle returned from MutexP_create
timeoutTimeout (in milliseconds) to wait for lock the mutex.
Returns
Status of the functions
  • MutexP_OK: Locked the mutex
  • MutexP_TIMEOUT: Timed out waiting for a mutex unlock
  • MutexP_FAILURE: Failed to lock the mutex

Variable Documentation

◆ object

void* MutexP_Object::object

Pointer to OS specifc mutex object

◆ key

uintptr_t MutexP_Object::key

The key returned during mutex lock