pthread_mgate.h File Reference

provides a repeatable threaded two dimensional for loop construct More...

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

Go to the source code of this file.

Data Structures
struct	pthread_mgateattr_t
	pthread_mgate_t attribute structure More...
struct	mgate_data_t
	pthread_mgate_t data structure More...
struct	pthread_mgate_t
	pthread_mgate_t structure More...
Functions
int	pthread_mgate_init (pthread_mgate_t *mgate, const pthread_mgateattr_t *attr, const int num_gates)
	initialize pthread_mgate_t structure
int	pthread_mgate_destroy (pthread_mgate_t *mgate)
	destroy pthread_mgate_t structure
int	pthread_mgate_check (pthread_mgate_t *mgate, const int gate_index, const int check_index)
	wait until gate is open
int	pthread_mgate_update (pthread_mgate_t *mgate, const int gate_index, const int update_index)
	update next gate to new values
int	pthread_mgate_pass (pthread_mgate_t *mgate, const int gate_index, int *order_number)
	update to next gate
int	pthread_mgate_reset (pthread_mgate_t *mgate)
	reset gate information to starting values
int	pthread_mgateattr_init (pthread_mgateattr_t *attr)
	initialize pthread_mgate_t attribute structure
int	pthread_mgateattr_destroy (pthread_mgateattr_t *attr)
	destroy pthread_mgate_t attribute structure

---

Detailed Description

provides a repeatable threaded two dimensional for loop construct

Warning:

• must cancel all threads using mgate

---

Function Documentation

int pthread_mgate_check	(	pthread_mgate_t *	mgate,
		const int	gate_index,
		const int	check_index
	)

wait until gate is open

Parameters:

	mgate	pointer to pthread_mgate_t structure
	gate_index	gate index ID
	check_index	check index

Returns:

0 is returned on success
non-zero error code is returned on failure

int pthread_mgate_destroy

(

pthread_mgate_t *

mgate

)

destroy pthread_mgate_t structure

Parameters:

mgate

pointer to pthread_mgate_t structure

Returns:

0 is returned on success
non-zero error code is returned on failure

int pthread_mgate_init	(	pthread_mgate_t *	mgate,
		const pthread_mgateattr_t *	attr,
		const int	num_gates
	)

initialize pthread_mgate_t structure

Parameters:

	mgate	pointer to pthread_mgate_t structure
	attr	pointer to pthread_mgate_t attribute structure
	num_gates	number of gates

Returns:

0 is returned on success
non-zero error code is returned on failure

int pthread_mgate_pass	(	pthread_mgate_t *	mgate,
		const int	gate_index,
		int *	order_number
	)

update to next gate

Parameters:

	mgate	pointer to pthread_mgate_t structure
	gate_index	gate index ID
	order_number	pointer to order number

Returns:

0 is returned on success
non-zero error code is returned on failure

int pthread_mgate_reset

(

pthread_mgate_t *

mgate

)

reset gate information to starting values

Parameters:

mgate

pointer to pthread_mgate_t structure

Returns:

0 is returned on success
non-zero error code is returned on failure

int pthread_mgate_update	(	pthread_mgate_t *	mgate,
		const int	gate_index,
		const int	update_index
	)

update next gate to new values

Parameters:

	mgate	pointer to pthread_mgate_t structure
	gate_index	gate index ID
	update_index	update index

Returns:

0 is returned on success
non-zero error code is returned on failure

int pthread_mgateattr_destroy

(

pthread_mgateattr_t *

attr

)

destroy pthread_mgate_t attribute structure

Parameters:

attr

pointer to pthread_mgate_t attribute structure

Returns:

0 is returned on success
non-zero error code is returned on failure

int pthread_mgateattr_init

(

pthread_mgateattr_t *

attr

)

initialize pthread_mgate_t attribute structure

Parameters:

attr

pointer to pthread_mgate_t attribute structure

Returns:

0 is returned on success
non-zero error code is returned on failure

---