diff options
Diffstat (limited to 'lib/libpthread/man/pthread_testcancel.3')
| -rw-r--r-- | lib/libpthread/man/pthread_testcancel.3 | 32 |
1 files changed, 19 insertions, 13 deletions
diff --git a/lib/libpthread/man/pthread_testcancel.3 b/lib/libpthread/man/pthread_testcancel.3 index 84fef8dbb57..cd0fcd6933e 100644 --- a/lib/libpthread/man/pthread_testcancel.3 +++ b/lib/libpthread/man/pthread_testcancel.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: pthread_testcancel.3,v 1.8 2002/04/30 16:31:42 mpech Exp $ +.\" $OpenBSD: pthread_testcancel.3,v 1.9 2002/05/01 08:03:30 mpech Exp $ .\" .Dd January 17, 1999 .Dt PTHREAD_TESTCANCEL 3 @@ -64,13 +64,14 @@ respectively. .Pp The .Fn pthread_testcancel -function creates a cancellation point in the calling thread. The +function creates a cancellation point in the calling thread. +The .Fn pthread_testcancel function has no effect if cancelability is disabled. .Ss Cancelability States The cancelability state of a thread determines the action taken upon -receipt of a cancellation request. The thread may control cancellation in -a number of ways. +receipt of a cancellation request. +The thread may control cancellation in a number of ways. .Pp Each thread maintains its own .Dq cancelability state @@ -87,7 +88,8 @@ new or pending cancellation requests may be acted upon at any time. When cancelability is enabled and the cancelability type is .Dv PTHREAD_CANCEL_DEFERRED , cancellation requests are held pending until a cancellation point (see -below) is reached. If cancelability is disabled, the setting of the +below) is reached. +If cancelability is disabled, the setting of the cancelability type has no immediate effect as all cancellation requests are held pending; however, once cancelability is enabled again the new type will be in effect. @@ -122,30 +124,33 @@ If successful, the .Fn pthread_setcancelstate and .Fn pthread_setcanceltype -functions will return zero. Otherwise, an error number shall be returned to -indicate the error. +functions will return zero. +Otherwise, an error number shall be returned to indicate the error. .Pp The .Fn pthread_setcancelstate and .Fn pthread_setcanceltype functions are used to control the points at which a thread may be -asynchronously cancelled. For cancellation control to be usable in modular +asynchronously cancelled. +For cancellation control to be usable in modular fashion, some rules must be followed. .Pp For purposes of this discussion, consider an object to be a generalization of a procedure. It is a set of procedures and global variables written as -a unit and called by clients not known by the object. Objects may depend -on other objects. +a unit and called by clients not known by the object. +Objects may depend on other objects. .Pp First, cancelability should only be disabled on entry to an object, never -explicitly enabled. On exit from an object, the cancelability state should +explicitly enabled. +On exit from an object, the cancelability state should always be restored to its value on entry to the object. .Pp This follows from a modularity argument: if the client of an object (or the client of an object that uses that object) has disabled cancelability, it is because the client doesn't want to have to worry about how to clean up if the -thread is cancelled while executing some sequence of actions. If an object +thread is cancelled while executing some sequence of actions. +If an object is called in such a state and it enables cancelability and a cancellation request is pending for that thread, then the thread will be cancelled, contrary to the wish of the client that disabled. @@ -154,7 +159,8 @@ Second, the cancelability type may be explicitly set to either .Em deferred or .Em asynchronous -upon entry to an object. But as with the cancelability state, on exit from +upon entry to an object. +But as with the cancelability state, on exit from an object that cancelability type should always be restored to its value on entry to the object. .Pp |