SEM.ih File Reference

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

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

Defines
#define	SEM__EXP_PROTO   INLINE_USR_EXP_PROTO
	Export Prototype spec.
#define	SEM__LCL_PROTO   INLINE_USR_LCL_PROTO
	Internal Prototype spec.
#define	SEM__EXP_FNC   INLINE_USR_EXP_FNC
	Export Function declaration.
#define	SEM__LCL_FNC   INLINE_USR_LCL_FNC
	Internal Function declaration.
Functions
SEM__EXP_PROTO SEM	SEM__create (unsigned int options) ATTR_UNUSED_OK
	Creates a semaphore.
SEM__EXP_PROTO unsigned int	SEM__takeW (SEM semaphore) ATTR_UNUSED_OK
	Takes the semaphore. This call will block until the semaphore can be acquired.
SEM__EXP_PROTO unsigned int	SEM__give (SEM give) ATTR_UNUSED_OK
	Gives the semaphore.
SEM__EXP_PROTO unsigned int	SEM__destroy (SEM semaphore) ATTR_UNUSED_OK
	Destroys the semaphore.

---

Detailed Description

Simple semaphore, inline interface and implementation.

Author:

JJRussell - russell@slac.stanford.edu

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

---

Function Documentation

SEM__EXP_PROTO SEM SEM__create

(

unsigned int

options

)

Creates a semaphore.

Returns:

Status

Parameters:

options

A bit mask of options formed from the enumeration SEM_OPTIONS_M

References MBA_alloc(), and MBA_free().

SEM__EXP_PROTO unsigned int SEM__destroy

(

SEM

semaphore

)

Destroys the semaphore.

Parameters:

semaphore

The semaphore to destroy

References MBA_free().

SEM__EXP_PROTO unsigned int SEM__give

(

SEM

semaphore

)

Gives the semaphore.

Parameters:

semaphore

The semaphore to give

SEM__EXP_PROTO unsigned int SEM__takeW

(

SEM

semaphore

)

Takes the semaphore. This call will block until the semaphore can be acquired.

Parameters:

semaphore

The semamphore to take