pthread_fifo_mutex.h File Reference

pthread_fifo_mutex_t are functions that provide a first-in first-out mutex More...

#include <pthread.h>
#include <unistd.h>

Go to the source code of this file.

Data Structures

struct  pthread_fifo_mutexattr_t
 pthread_fifo_mutex_t attribute structure More...
struct  fifo_data_t
 pthread_fifo_mutex_t data structure More...
struct  pthread_fifo_mutex_t
 pthread_fifo_mutex_t structure More...

Defines

#define PTHREAD_FIFO_MUTEX_NONBLOCKING   PTHREAD_FIFO_MUTEX_NONBLOCKING
 non-blocking enumeration
#define PTHREAD_FIFO_MUTEX_BLOCKING   PTHREAD_FIFO_MUTEX_BLOCKING
 blocking enumeration
#define PTHREAD_FIFO_MUTEX_DEFAULT   PTHREAD_FIFO_MUTEX_DEFAULT
 default blocking enumeration

Enumerations

enum  { PTHREAD_FIFO_MUTEX_NONBLOCKING, PTHREAD_FIFO_MUTEX_BLOCKING, PTHREAD_FIFO_MUTEX_DEFAULT = PTHREAD_FIFO_MUTEX_BLOCKING }
 enumeration for fifo objects More...

Functions

int pthread_fifo_mutex_init (pthread_fifo_mutex_t *mutex, const pthread_fifo_mutexattr_t *attr, const int length)
 initialize pthread_fifo_mutex_t structure
int pthread_fifo_mutex_destroy (pthread_fifo_mutex_t *mutex)
 destroy pthread_fifo_mutex_t structure
int pthread_fifo_mutex_lock (pthread_fifo_mutex_t *mutex)
 suspend calling thread until lock is available
int pthread_fifo_mutex_trylock (pthread_fifo_mutex_t *mutex)
 if mutex is not lock then obtain lock
int pthread_fifo_mutex_timedlock (pthread_fifo_mutex_t *mutex, const struct timespec *abstime)
 if mutex is not lock then obtain lock or return after abstime
int pthread_fifo_mutex_unlock (pthread_fifo_mutex_t *mutex)
 unlock mutex
int pthread_fifo_mutexattr_init (pthread_fifo_mutexattr_t *attr)
 initialize pthread_fifo_mutex_t attribute structure
int pthread_fifo_mutexattr_destroy (pthread_fifo_mutexattr_t *attr)
 destroy pthread_fifo_mutex_t attribute structure
int pthread_fifo_mutexattr_getblock (const pthread_fifo_mutexattr_t *attr, int *block)
 assign block the current blocking attribute
int pthread_fifo_mutexattr_setblock (pthread_fifo_mutexattr_t *attr, const int block)
 assign the current blocking attribute

Detailed Description

pthread_fifo_mutex_t are functions that provide a first-in first-out mutex

Warning:

Enumeration Type Documentation

anonymous enum

enumeration for fifo objects

Enumerator:
PTHREAD_FIFO_MUTEX_NONBLOCKING  non-blocking enumeration
PTHREAD_FIFO_MUTEX_BLOCKING  blocking enumeration
PTHREAD_FIFO_MUTEX_DEFAULT  default blocking enumeration

Function Documentation

int pthread_fifo_mutex_destroy ( pthread_fifo_mutex_t *  mutex  ) 

destroy pthread_fifo_mutex_t structure

Parameters:
mutex pointer to pthread_fifo_mutex_t structure
Returns:
0 is returned on success
non-zero error code is returned on failure

int pthread_fifo_mutex_init ( pthread_fifo_mutex_t *  mutex,
const pthread_fifo_mutexattr_t *  attr,
const int  length 
)

initialize pthread_fifo_mutex_t structure

Parameters:
mutex pointer to pthread_fifo_mutex_t structure
attr pointer to pthread_fifo_mutex_t attribute structure
length maximum length of fifo
Returns:
0 is returned on success
non-zero error code is returned on failure

int pthread_fifo_mutex_lock ( pthread_fifo_mutex_t *  mutex  ) 

suspend calling thread until lock is available

Parameters:
mutex pointer to pthread_fifo_mutex_t structure
Returns:
0 is returned on success
non-zero error code is returned on failure

int pthread_fifo_mutex_timedlock ( pthread_fifo_mutex_t *  mutex,
const struct timespec *  abstime 
)

if mutex is not lock then obtain lock or return after abstime

Parameters:
mutex pointer to pthread_fifo_mutex_t structure
abstime pointer to timespec structure
Returns:
0 is returned on success
non-zero error code is returned on failure

int pthread_fifo_mutex_trylock ( pthread_fifo_mutex_t *  mutex  ) 

if mutex is not lock then obtain lock

Parameters:
mutex pointer to pthread_fifo_mutex_t structure
Returns:
0 is returned on success
non-zero error code is returned on failure

int pthread_fifo_mutex_unlock ( pthread_fifo_mutex_t *  mutex  ) 

unlock mutex

Parameters:
mutex pointer to pthread_fifo_mutex_t structure
Returns:
0 is returned on success
non-zero error code is returned on failure

int pthread_fifo_mutexattr_destroy ( pthread_fifo_mutexattr_t *  attr  ) 

destroy pthread_fifo_mutex_t attribute structure

Parameters:
attr pointer to pthread_fifo_mutex_t structure
Returns:
0 is returned on success
non-zero error code is returned on failure

int pthread_fifo_mutexattr_getblock ( const pthread_fifo_mutexattr_t *  attr,
int *  block 
)

assign block the current blocking attribute

Parameters:
attr pointer to pthread_fifo_mutex_t structure
block pointer to blocking attribute
Returns:
0 is returned on success
non-zero error code is returned on failure

int pthread_fifo_mutexattr_init ( pthread_fifo_mutexattr_t *  attr  ) 

initialize pthread_fifo_mutex_t attribute structure

Parameters:
attr pointer to pthread_fifo_mutex_t structure
Returns:
0 is returned on success
non-zero error code is returned on failure

int pthread_fifo_mutexattr_setblock ( pthread_fifo_mutexattr_t *  attr,
const int  block 
)

assign the current blocking attribute

Parameters:
attr pointer to pthread_fifo_mutex_t structure
block blocking attribute
Returns:
0 is returned on success
non-zero error code is returned on failure

Generated on Tue Apr 24 20:01:36 2007 for libctf by  doxygen 1.5.1