NAME

pthread_cancel - cancel execution of a thread

SYNOPSIS

[THR] #include <pthread.h>

int pthread_cancel(pthread_t thread);

DESCRIPTION

The pthread_cancel() function shall request that thread be canceled. The target thread's cancelability state and type determines when the cancelation takes effect. When the cancelation is acted on, the cancelation cleanup handlers for thread shall be called. When the last cancelation cleanup handler returns, the thread-specific data destructor functions shall be called for thread. When the last destructor function returns, thread shall be terminated.

The cancelation processing in the target thread shall run asynchronously with respect to the calling thread returning from pthread_cancel().

RETURN VALUE

If successful, the pthread_cancel() function shall return zero; otherwise, an error number shall be returned to indicate the error.

ERRORS

The pthread_cancel() function may fail if:

[ESRCH]

No thread could be found corresponding to that specified by the given thread ID.

The pthread_cancel() function shall not return an error code of [EINTR].

EXAMPLES

None.

APPLICATION USAGE

None.

RATIONALE

Two alternative functions were considered for sending the cancelation notification to a thread. One would be to define a new SIGCANCEL signal that had the cancelation semantics when delivered; the other was to define the new pthread_cancel() function, which would trigger the cancelation semantics.

The advantage of a new signal was that so much of the delivery criteria were identical to that used when trying to deliver a signal that making cancelation notification a signal was seen as consistent. Indeed, many implementations implement cancelation using a special signal. On the other hand, there would be no signal functions that could be used with this signal except pthread_kill(), and the behavior of the delivered cancelation signal would be unlike any previously existing defined signal.

The benefits of a special function include the recognition that this signal would be defined because of the similar delivery criteria and that this is the only common behavior between a cancelation request and a signal. In addition, the cancelation delivery mechanism does not have to be implemented as a signal. There are also strong, if not stronger, parallels with language exception mechanisms than with signals that are potentially obscured if the delivery mechanism is visibly closer to signals.

In the end, it was considered that as there were so many exceptions to the use of the new signal with existing signals functions it would be misleading. A special function has resolved this problem. This function was carefully defined so that an implementation wishing to provide the cancelation functions on top of signals could do so. The special function also means that implementations are not obliged to implement cancelation with signals.

FUTURE DIRECTIONS

None.

SEE ALSO

pthread_exit() , pthread_cond_timedwait() , pthread_join() , pthread_setcancelstate() , the Base Definitions volume of IEEE Std 1003.1-2001, <pthread.h>

CHANGE HISTORY

First released in Issue 5. Included for alignment with the POSIX Threads Extension.

Issue 6

The pthread_cancel() function is marked as part of the Threads option.