iotcs_port_mutex.h File Reference

The file contains porting layer for mutexes. More...

#include "iotcs_config.h"

Go to the source code of this file.

Typedefs
typedef void *	iotcs_port_mutex
	Mutex handle.
Functions
iotcs_port_mutex	iotcs_port_mutex_create (void)
	Creates iotcs_port_mutex instance.
void	iotcs_port_mutex_destroy (iotcs_port_mutex mutex)
	Destroys iotcs_port_mutex instance If a mutex is NULL, no operation is performed.
void	iotcs_port_mutex_lock (iotcs_port_mutex mutex)
	Locks iotcs_port_mutex instance Recursive lock support is not required.
void	iotcs_port_mutex_unlock (iotcs_port_mutex mutex)
	Unlocks iotcs_port_mutex instance Recursive lock support is not required.

---

Detailed Description

The file contains porting layer for mutexes.

---

Function Documentation

iotcs_port_mutex iotcs_port_mutex_create

(

void

)

Creates iotcs_port_mutex instance.

Note:

Optional API. Called by the Library if IOTCS_MESSAGING_THREAD_SAFETY option is defined.

Returns:

iotcs_port_mutex on success

NULL if failed

void iotcs_port_mutex_destroy

(

iotcs_port_mutex

mutex

)

Destroys iotcs_port_mutex instance If a mutex is NULL, no operation is performed.

Note:

Optional API. Called by the Library if IOTCS_MESSAGING_THREAD_SAFETY option is defined.

Parameters:

mutex

iotcs_port_mutex instance

void iotcs_port_mutex_lock

(

iotcs_port_mutex

mutex

)

Locks iotcs_port_mutex instance Recursive lock support is not required.

Note:

Optional API. Called by the Library if IOTCS_MESSAGING_THREAD_SAFETY option is defined.

Parameters:

mutex

non NULL iotcs_port_mutex instance

void iotcs_port_mutex_unlock

(

iotcs_port_mutex

mutex

)

Unlocks iotcs_port_mutex instance Recursive lock support is not required.

Note:

Optional API. Called by the Library if IOTCS_MESSAGING_THREAD_SAFETY option is defined.

Parameters:

mutex

non NULL iotcs_port_mutex instance