az_pal_os_api.h File Reference

A minimalistic platform agnostic abstraction. More...

#include "azure_macro_utils/macro_utils.h"
#include "umock_c/umock_c_prod.h"
#include "az_pal_os.h"

Go to the source code of this file.

Functions
void	az_pal_os_lock_init (AZ_PAL_OS_LOCK *lock)
	This API initialize and returns a valid lock handle. More...
void	az_pal_os_lock_deinit (AZ_PAL_OS_LOCK *lock)
	The lock instance is destroyed. More...
void	az_pal_os_lock_acquire (AZ_PAL_OS_LOCK *lock)
	Acquires a lock on the given lock handle. Uses platform specific mutex primitives in its implementation. More...
void	az_pal_os_lock_release (AZ_PAL_OS_LOCK *lock)
	Releases the lock on the given lock handle. Uses platform specific mutex primitives in its implementation. More...

Detailed Description

A minimalistic platform agnostic abstraction.

Definition in file az_pal_os_api.h.

Function Documentation

az_pal_os_lock_acquire()

void az_pal_os_lock_acquire

(

AZ_PAL_OS_LOCK *

lock

)

Acquires a lock on the given lock handle. Uses platform specific mutex primitives in its implementation.

Parameters

[in]

lock

The AZ_PAL_OS_LOCK * that points to a valid lock handle.

az_pal_os_lock_deinit()

void az_pal_os_lock_deinit

(

AZ_PAL_OS_LOCK *

lock

)

The lock instance is destroyed.

Parameters

[in]

lock

The AZ_PAL_OS_LOCK * that points to a valid lock handle.

az_pal_os_lock_init()

void az_pal_os_lock_init

(

AZ_PAL_OS_LOCK *

lock

)

This API initialize and returns a valid lock handle.

Parameters

[in,out]

lock

The AZ_PAL_OS_LOCK * that points to the lock handle.

az_pal_os_lock_release()

void az_pal_os_lock_release

(

AZ_PAL_OS_LOCK *

lock

)

Releases the lock on the given lock handle. Uses platform specific mutex primitives in its implementation.

Parameters

[in]

lock

The AZ_PAL_OS_LOCK * that points to a valid lock handle.