MTX.ih File Reference

Simple mutex, inline interface and implementation. More...

#include <PBI/Inline.h>
#include <PBI/Attribute.h>
#include <PBS/MTX.h>

Defines
#define	MTX__EXP_PROTO   INLINE_USR_EXP_PROTO
	Export Prototype spec.
#define	MTX__LCL_PROTO   INLINE_USR_LCL_PROTO
	Internal Prototype spec.
#define	MTX__EXP_FNC   INLINE_USR_EXP_FNC
	Export Function declaration.
#define	MTX__LCL_FNC   INLINE_USR_LCL_FNC
	Internal Function declaration.
Functions
MTX__EXP_PROTO MTX	MTX__create (unsigned int options) ATTR_UNUSED_OK
	Creates a mutex.
MTX__EXP_PROTO unsigned int	MTX__lock (MTX mutex) ATTR_UNUSED_OK
	Locks the mutex. This call may block until the mutex can be locked.
MTX__EXP_PROTO unsigned int	MTX__unlock (MTX mutex) ATTR_UNUSED_OK
	Unlocks the mutex.
MTX__EXP_PROTO unsigned int	MTX__destroy (MTX mutex) ATTR_UNUSED_OK
	Destroys the mutex.

---

Detailed Description

Simple mutex, inline interface and implementation.

Author:

JJRussell - russell@slac.stanford.edu

    CVS $Id: MTX.ih,v 1.4 2011/03/24 23:05:42 apw Exp $

---

Function Documentation

MTX__EXP_PROTO MTX MTX__create

(

unsigned int

options

)

Creates a mutex.

Returns:

Status

Parameters:

options

A bit mask of options formed from the enumeration MTX_OPTIONS_M

References MBA_alloc(), and MBA_free().

MTX__EXP_PROTO unsigned int MTX__destroy

(

MTX

mutex

)

Destroys the mutex.

Parameters:

mutex

The mutex to destroy

References MBA_free().

MTX__EXP_PROTO unsigned int MTX__lock

(

MTX

mutex

)

Locks the mutex. This call may block until the mutex can be locked.

Parameters:

mutex

The mutex to lock

MTX__EXP_PROTO unsigned int MTX__unlock

(

MTX

mutex

)

Unlocks the mutex.

Parameters:

mutex

The mutex to lock