MTX.h File Reference

Simple mutex, interface definition. More...

Functions
MTX	MTX_create (unsigned int options)
	Creates a mutex.
unsigned int	MTX_lock (MTX mutex)
	Locks the mutex. This call may block until the mutex can be locked.
unsigned int	MTX_unlock (MTX mutex)
	Unlocks the mutex.
unsigned int	MTX_destroy (MTX mutex)
	Destroys the mutex.

---

Detailed Description

Simple mutex, interface definition.

Author:

JJRussell - russell@slac.stanford.edu

    CVS $Id: MTX.h,v 1.2 2011/03/25 21:15:01 saxton Exp $

---

Function Documentation

MTX MTX_create

(

unsigned int

options

)

Creates a mutex.

Return values:

	NON-NULL	A pointer to the created mutex
	NULL	Error in the creation

Parameters:

options

A bit mask of options formed from the enumeration MTX_OPTIONS_M

unsigned int MTX_destroy

(

MTX

mutex

)

Destroys the mutex.

Parameters:

mutex

The mutex to destroy

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

unsigned int MTX_unlock

(

MTX

mutex

)

Unlocks the mutex.

Parameters:

mutex

The mutex to lock