diff options
Diffstat (limited to 'doc/new_chapters/cond.t')
-rw-r--r-- | doc/new_chapters/cond.t | 323 |
1 files changed, 0 insertions, 323 deletions
diff --git a/doc/new_chapters/cond.t b/doc/new_chapters/cond.t deleted file mode 100644 index 4c381a6864..0000000000 --- a/doc/new_chapters/cond.t +++ /dev/null @@ -1,323 +0,0 @@ -@c -@c COPYRIGHT (c) 1988-1998. -@c On-Line Applications Research Corporation (OAR). -@c All rights reserved. -@c -@c $Id$ -@c - -@chapter Condition Variable Manager - -@section Introduction - -The condition variable manager ... - -The directives provided by the condition variable manager are: - -@itemize @bullet -@item @code{pthread_condattr_init} - -@item @code{pthread_condattr_destroy} - -@item @code{pthread_condattr_setpshared} - -@item @code{pthread_condattr_getpshared} - -@item @code{pthread_cond_init} - -@item @code{pthread_cond_destroy} - -@item @code{pthread_cond_signal} - -@item @code{pthread_cond_broadcast} - -@item @code{pthread_cond_wait} - -@item @code{pthread_cond_timedwait} - -@end itemize - -@section Background - -There is currently no text in this section. - -@section Operations - -There is currently no text in this section. - -@section Directives - -This section details the condition variable manager's directives. -A subsection is dedicated to each of this manager's directives -and describes the calling sequence, related constants, usage, -and status codes. - -@page -@subsection pthread_condattr_init - -@subheading CALLING SEQUENCE: - -@example -#include <pthread.h> - -int pthread_condattr_init( - pthread_condattr_t *attr -); -@end example - -@subheading STATUS CODES: -@table @b -@item ENOMEM -Insufficient memory is available to initialize the condition variable -attributes object. - -@end table - -@subheading DESCRIPTION: - -@subheading NOTES: - -@page -@subsection pthread_condattr_destroy - -@subheading CALLING SEQUENCE: - -@example -#include <pthread.h> - -int pthread_condattr_destroy( - pthread_condattr_t *attr -); -@end example - -@subheading STATUS CODES: -@table @b -@item EINVAL -The attribute object specified is invalid. - -@end table - -@subheading DESCRIPTION: - -@subheading NOTES: - -@page -@subsection pthread_condattr_setpshared - -@subheading CALLING SEQUENCE: - -@example -#include <pthread.h> - -int pthread_condattr_setpshared( - pthread_condattr_t *attr, - int pshared -); -@end example - -@subheading STATUS CODES: - -@table @b -@item EINVAL -Invalid argument passed. - -@end table - -@subheading DESCRIPTION: - -@subheading NOTES: - -@page -@subsection pthread_condattr_getpshared - -@subheading CALLING SEQUENCE: - -@example -#include <pthread.h> - -int pthread_condattr_getpshared( - const pthread_condattr_t *attr, - int *pshared -); -@end example - -@subheading STATUS CODES: - -@table @b -@item EINVAL -Invalid argument passed. - -@end table - -@subheading DESCRIPTION: - -@subheading NOTES: - - -@page -@subsection pthread_cond_init - -@subheading CALLING SEQUENCE: - -@example -#include <pthread.h> - -int pthread_cond_init( - pthread_cond_t *cond, - const pthread_condattr_t *attr -); -@end example - -@subheading STATUS CODES: -@table @b -@item EAGAIN -The system lacked a resource other than memory necessary to create the -initialize the condition variable object. - -@item ENOMEM -Insufficient memory is available to initialize the condition variable object. - -@item EBUSY -The specified condition variable has already been initialized. - -@item EINVAL -The specified attribute value is invalid. - -@end table - -@subheading DESCRIPTION: - -@subheading NOTES: - -@page -@subsection pthread_cond_destroy - -@subheading CALLING SEQUENCE: - -@example -#include <pthread.h> - -int pthread_cond_destroy( - pthread_cond_t *cond -); -@end example - -@subheading STATUS CODES: -@table @b -@item EINVAL -The specified condition variable is invalid. - -@item EBUSY -The specified condition variable is currently in use. - -@end table - -@subheading DESCRIPTION: - -@subheading NOTES: - -@page -@subsection pthread_cond_signal - -@subheading CALLING SEQUENCE: - -@example -#include <pthread.h> - -int pthread_cond_signal( - pthread_cond_t *cond -); -@end example - -@subheading STATUS CODES: -@table @b -@item EINVAL -The specified condition variable is not valid. - -@end table - -@subheading DESCRIPTION: - -@subheading NOTES: - -This routine should not be invoked from a handler from an asynchronous signal -handler or an interrupt service routine. - -@page -@subsection pthread_cond_broadcast - -@subheading CALLING SEQUENCE: - -@example -#include <pthread.h> - -int pthread_cond_broadcast( - pthread_cond_t *cond -); -@end example - -@subheading STATUS CODES: -@table @b -@item EINVAL -The specified condition variable is not valid. - -@end table - -@subheading DESCRIPTION: - -@subheading NOTES: - -This routine should not be invoked from a handler from an asynchronous signal -handler or an interrupt service routine. - -@page -@subsection pthread_cond_wait - -@subheading CALLING SEQUENCE: - -@example -#include <pthread.h> - -int pthread_cond_wait( - pthread_cond_t *cond, - pthread_mutex_t *mutex -); -@end example - -@subheading STATUS CODES: -@table @b -@item EINVAL -The specified condition variable or mutex is not initialized OR different -mutexes were specified for concurrent pthread_cond_wait() and -pthread_cond_timedwait() operations on the same condition variable OR -the mutex was not owned by the current thread at the time of the call. - -@end table - -@subheading DESCRIPTION: - -@subheading NOTES: - -@page -@subsection pthread_cond_timedwait - -@subheading CALLING SEQUENCE: - -@example -#include <pthread.h> - -int pthread_cond_timedwait( - pthread_cond_t *cond, - pthread_mutex_t *mutex, - const struct timespec *abstime -); -@end example - -@subheading STATUS CODES: -@table @b -@item EINVAL -The specified condition variable or mutex is not initialized OR different -mutexes were specified for concurrent pthread_cond_wait() and -pthread_cond_timedwait() operations on the same condition variable OR -the mutex was not owned by the current thread at the time of the call. - -@item ETIMEDOUT -The specified time has elapsed without the condition variable being -satisfied. - -@end table - -@subheading DESCRIPTION: - -@subheading NOTES: - |