Added descriptions.

This commit is contained in:
Joel Sherrill
1999-10-11 20:24:37 +00:00
parent ffce9b39ea
commit a518cc11e1
3 changed files with 66 additions and 38 deletions

View File

@@ -16,11 +16,12 @@ thread cancellation manager is ...
The directives provided by the thread cancellation manager are:
@itemize @bullet
@item @code{pthread_cancel} -
@item @code{pthread_setcancelstate} -
@item @code{pthread_setcanceltype} -
@item @code{pthread_testcancel} -
@item @code{pthread_cleanup_push} -
@item @code{pthread_cancel} - Cancel Execution of a Thread
@item @code{pthread_setcancelstate} - Set Cancelability State
@item @code{pthread_setcanceltype} - Set Cancelability Type
@item @code{pthread_testcancel} - Create Cancellation Point
@item @code{pthread_cleanup_push} - Establish Cancellation Handler
@item @code{pthread_cleanup_pop} - Remove Cancellation Handler
@end itemize
@section Background
@@ -39,7 +40,7 @@ and describes the calling sequence, related constants, usage,
and status codes.
@page
@subsection pthread_cancel -
@subsection pthread_cancel - Cancel Execution of a Thread
@subheading CALLING SEQUENCE:
@@ -66,7 +67,7 @@ The
@subheading NOTES:
@page
@subsection pthread_setcancelstate -
@subsection pthread_setcancelstate - Set Cancelability State
@subheading CALLING SEQUENCE:
@@ -93,7 +94,7 @@ The
@subheading NOTES:
@page
@subsection pthread_setcanceltype -
@subsection pthread_setcanceltype - Set Cancelability Type
@subheading CALLING SEQUENCE:
@@ -120,7 +121,7 @@ The
@subheading NOTES:
@page
@subsection pthread_testcancel -
@subsection pthread_testcancel - Create Cancellation Point
@subheading CALLING SEQUENCE:
@@ -147,7 +148,34 @@ The
@subheading NOTES:
@page
@subsection pthread_cleanup_push -
@subsection pthread_cleanup_push - Establish Cancellation Handler
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int pthread_cleanup_push(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@page
@subsection pthread_cleanup_pop - Remove Cancellation Handler
@subheading CALLING SEQUENCE:

View File

@@ -15,11 +15,11 @@ The clock manager ...
The directives provided by the clock manager are:
@itemize @bullet
@item @code{clock_gettime} -
@item @code{clock_settime} -
@item @code{clock_getres} -
@item @code{clock_gettime} - Obtain Time of Day
@item @code{clock_settime} - Set Time of Day
@item @code{clock_getres} - Get Clock Resolution
@item @code{sleep} - Delay Process Execution
@item @code{nanosleep} -
@item @code{nanosleep} - Delay with High Resolution
@item @code{gettimeofday} - Get the Time of Day
@item @code{time} - Get time in seconds
@end itemize
@@ -39,7 +39,7 @@ A subsection is dedicated to each of this manager's directives
and describes the calling sequence, related constants, usage,
and status codes.
@subsection clock_gettime -
@subsection clock_gettime -Obtain Time of Day
@subheading CALLING SEQUENCE:
@@ -71,7 +71,7 @@ The clock_id specified is invalid.
NONE
@page
@subsection clock_settime -
@subsection clock_settime - Set Time of Day
@subheading CALLING SEQUENCE:
@@ -107,7 +107,7 @@ The contents of the tp structure are invalid.
NONE
@page
@subsection clock_getres -
@subsection clock_getres - Get Clock Resolution
@subheading CALLING SEQUENCE:
@@ -166,7 +166,7 @@ number of @code{seconds}.
This call is interruptible by a signal.
@page
@subsection nanosleep -
@subsection nanosleep - Delay with High Resolution
@subheading CALLING SEQUENCE:

View File

@@ -15,16 +15,16 @@ 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} -
@item @code{pthread_condattr_init} - Initialize a Condition Variable Attribute Set
@item @code{pthread_condattr_destroy} - Destroy a Condition Variable Attribute Set
@item @code{pthread_condattr_setpshared} - Set Process Shared Attribute
@item @code{pthread_condattr_getpshared} - Get Process Shared Attribute
@item @code{pthread_cond_init} - Initialize a Condition Variable
@item @code{pthread_cond_destroy} - Destroy a Condition Variable
@item @code{pthread_cond_signal} - Signal a Condition Variable
@item @code{pthread_cond_broadcast} - Broadcast a Condition Variable
@item @code{pthread_cond_wait} - Wait on a Condition Variable
@item @code{pthread_cond_timedwait} - With with Timeout a Condition Variable
@end itemize
@section Background
@@ -43,7 +43,7 @@ and describes the calling sequence, related constants, usage,
and status codes.
@page
@subsection pthread_condattr_init -
@subsection pthread_condattr_init - Initialize a Condition Variable Attribute Set
@subheading CALLING SEQUENCE:
@@ -68,7 +68,7 @@ attributes object.
@subheading NOTES:
@page
@subsection pthread_condattr_destroy -
@subsection pthread_condattr_destroy - Destroy a Condition Variable Attribute Set
@subheading CALLING SEQUENCE:
@@ -92,7 +92,7 @@ The attribute object specified is invalid.
@subheading NOTES:
@page
@subsection pthread_condattr_setpshared -
@subsection pthread_condattr_setpshared - Set Process Shared Attribute
@subheading CALLING SEQUENCE:
@@ -118,7 +118,7 @@ Invalid argument passed.
@subheading NOTES:
@page
@subsection pthread_condattr_getpshared -
@subsection pthread_condattr_getpshared - Get Process Shared Attribute
@subheading CALLING SEQUENCE:
@@ -145,7 +145,7 @@ Invalid argument passed.
@page
@subsection pthread_cond_init -
@subsection pthread_cond_init - Initialize a Condition Variable
@subheading CALLING SEQUENCE:
@@ -180,7 +180,7 @@ The specified attribute value is invalid.
@subheading NOTES:
@page
@subsection pthread_cond_destroy -
@subsection pthread_cond_destroy - Destroy a Condition Variable
@subheading CALLING SEQUENCE:
@@ -207,7 +207,7 @@ The specified condition variable is currently in use.
@subheading NOTES:
@page
@subsection pthread_cond_signal -
@subsection pthread_cond_signal - Signal a Condition Variable
@subheading CALLING SEQUENCE:
@@ -234,7 +234,7 @@ This routine should not be invoked from a handler from an asynchronous signal
handler or an interrupt service routine.
@page
@subsection pthread_cond_broadcast -
@subsection pthread_cond_broadcast - Broadcast a Condition Variable
@subheading CALLING SEQUENCE:
@@ -261,7 +261,7 @@ This routine should not be invoked from a handler from an asynchronous signal
handler or an interrupt service routine.
@page
@subsection pthread_cond_wait -
@subsection pthread_cond_wait - Wait on a Condition Variable
@subheading CALLING SEQUENCE:
@@ -289,7 +289,7 @@ the mutex was not owned by the current thread at the time of the call.
@subheading NOTES:
@page
@subsection pthread_cond_timedwait -
@subsection pthread_cond_timedwait - Wait with Timeout a Condition Variable
@subheading CALLING SEQUENCE: