MTX.ih.px-xxx-xxx File Reference

Simple mutex, POSIX platform dependent inline implementation. More...

#include <PBS/MBA.h>
#include <PBS/MTX.h>
#include <pthread.h>

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, POSIX platform dependent inline implementation.

Author:

JJRussell - russell@slac.stanford.edu

    CVS $Id: MTX.ih.px-xxx-xxx,v 1.3 2011/03/24 23:05:45 apw Exp $

---

Function Documentation

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().

unsigned int MTX__destroy

(

MTX

mutex

)

Destroys the mutex.

Parameters:

mutex

The mutex to destroy

References MBA_free().

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