From 7479042a5914a6b9223e734b4a14652314661e1a Mon Sep 17 00:00:00 2001 From: Joel Sherrill Date: Mon, 11 Oct 1999 21:24:38 +0000 Subject: Generated concept and function index entries. --- doc/posix_users/cond.t | 126 ++++++++++++++++++++++++++++++++++++------------- 1 file changed, 93 insertions(+), 33 deletions(-) (limited to 'doc/posix_users/cond.t') diff --git a/doc/posix_users/cond.t b/doc/posix_users/cond.t index 52a201a54a..95e30376b2 100644 --- a/doc/posix_users/cond.t +++ b/doc/posix_users/cond.t @@ -1,9 +1,9 @@ @c -@c COPYRIGHT (c) 1988-1998. -@c On-Line Applications Research Corporation (OAR). -@c All rights reserved. +@c COPYRIGHT (c) 1988-1998. +@c On-Line Applications Research Corporation (OAR). +@c All rights reserved. @c -@c $Id$ +@c $Id$ @c @chapter Condition Variable Manager @@ -42,16 +42,22 @@ A subsection is dedicated to each of this manager's directives and describes the calling sequence, related constants, usage, and status codes. +@c +@c +@c @page @subsection pthread_condattr_init - Initialize a Condition Variable Attribute Set +@findex pthread_condattr_init +@cindex initialize a condition variable attribute set + @subheading CALLING SEQUENCE: @example #include int pthread_condattr_init( - pthread_condattr_t *attr +pthread_condattr_t *attr ); @end example @@ -67,16 +73,22 @@ attributes object. @subheading NOTES: +@c +@c +@c @page @subsection pthread_condattr_destroy - Destroy a Condition Variable Attribute Set +@findex pthread_condattr_destroy +@cindex destroy a condition variable attribute set + @subheading CALLING SEQUENCE: @example #include int pthread_condattr_destroy( - pthread_condattr_t *attr +pthread_condattr_t *attr ); @end example @@ -91,52 +103,64 @@ The attribute object specified is invalid. @subheading NOTES: +@c +@c +@c @page @subsection pthread_condattr_setpshared - Set Process Shared Attribute +@findex pthread_condattr_setpshared +@cindex set process shared attribute + @subheading CALLING SEQUENCE: @example #include int pthread_condattr_setpshared( - pthread_condattr_t *attr, - int pshared +pthread_condattr_t *attr, +int pshared ); @end example @subheading STATUS CODES: - + @table @b @item EINVAL Invalid argument passed. - + @end table @subheading DESCRIPTION: @subheading NOTES: +@c +@c +@c @page @subsection pthread_condattr_getpshared - Get Process Shared Attribute +@findex pthread_condattr_getpshared +@cindex get process shared attribute + @subheading CALLING SEQUENCE: @example #include int pthread_condattr_getpshared( - const pthread_condattr_t *attr, - int *pshared +const pthread_condattr_t *attr, +int *pshared ); @end example @subheading STATUS CODES: - + @table @b @item EINVAL Invalid argument passed. - + @end table @subheading DESCRIPTION: @@ -144,17 +168,23 @@ Invalid argument passed. @subheading NOTES: +@c +@c +@c @page @subsection pthread_cond_init - Initialize a Condition Variable +@findex pthread_cond_init +@cindex initialize a condition variable + @subheading CALLING SEQUENCE: @example #include int pthread_cond_init( - pthread_cond_t *cond, - const pthread_condattr_t *attr +pthread_cond_t *cond, +const pthread_condattr_t *attr ); @end example @@ -162,7 +192,7 @@ int pthread_cond_init( @table @b @item EAGAIN The system lacked a resource other than memory necessary to create the -initialize the condition variable object. +initialize the condition variable object. @item ENOMEM Insufficient memory is available to initialize the condition variable object. @@ -179,16 +209,22 @@ The specified attribute value is invalid. @subheading NOTES: +@c +@c +@c @page @subsection pthread_cond_destroy - Destroy a Condition Variable +@findex pthread_cond_destroy +@cindex destroy a condition variable + @subheading CALLING SEQUENCE: @example #include int pthread_cond_destroy( - pthread_cond_t *cond +pthread_cond_t *cond ); @end example @@ -206,16 +242,22 @@ The specified condition variable is currently in use. @subheading NOTES: +@c +@c +@c @page @subsection pthread_cond_signal - Signal a Condition Variable +@findex pthread_cond_signal +@cindex signal a condition variable + @subheading CALLING SEQUENCE: @example #include int pthread_cond_signal( - pthread_cond_t *cond +pthread_cond_t *cond ); @end example @@ -230,19 +272,25 @@ The specified condition variable is not valid. @subheading NOTES: -This routine should not be invoked from a handler from an asynchronous signal +This routine should not be invoked from a handler from an asynchronous signal handler or an interrupt service routine. +@c +@c +@c @page @subsection pthread_cond_broadcast - Broadcast a Condition Variable +@findex pthread_cond_broadcast +@cindex broadcast a condition variable + @subheading CALLING SEQUENCE: @example #include int pthread_cond_broadcast( - pthread_cond_t *cond +pthread_cond_t *cond ); @end example @@ -257,28 +305,34 @@ The specified condition variable is not valid. @subheading NOTES: -This routine should not be invoked from a handler from an asynchronous signal +This routine should not be invoked from a handler from an asynchronous signal handler or an interrupt service routine. +@c +@c +@c @page @subsection pthread_cond_wait - Wait on a Condition Variable +@findex pthread_cond_wait +@cindex wait on a condition variable + @subheading CALLING SEQUENCE: @example #include int pthread_cond_wait( - pthread_cond_t *cond, - pthread_mutex_t *mutex +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 +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. @@ -288,31 +342,37 @@ the mutex was not owned by the current thread at the time of the call. @subheading NOTES: +@c +@c +@c @page @subsection pthread_cond_timedwait - Wait with Timeout a Condition Variable +@findex pthread_cond_timedwait +@cindex wait with timeout a condition variable + @subheading CALLING SEQUENCE: @example #include int pthread_cond_timedwait( - pthread_cond_t *cond, - pthread_mutex_t *mutex, - const struct timespec *abstime +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 +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 +The specified time has elapsed without the condition variable being satisfied. @end table -- cgit v1.2.3