Sun Microsystems, Inc.
spacerspacer
spacer   www.sun.com docs.sun.com | | |  
spacer
black dot
   
A   B   C   D   E   F   G   H   I   J   K   L   M   N   O   P   Q   R   S   T   U   V   W   X   Y   Z
    
 
Threads Library Functionspthread_cancel(3THR)


NAME

 pthread_cancel - cancel execution of a thread

SYNOPSIS

 
cc -mt [ flag... ] file... -lpthread [ -lrt library... ]
#include <pthread.h>
int pthread_cancel(pthread_t target_thread);

DESCRIPTION

 

The pthread_cancel() function requests that target_thread be canceled.

By default, cancellation is deferred until target_thread reaches a cancellation point. See cancellation(3THR).

Cancellation cleanup handlers for target_thread are called when the cancellation is acted on. Upon return of the last cancellation cleanup handler, the thread-specific data destructor functions are called for target_thread. target_thread is terminated when the last destructor function returns.

The cancellation processing in target_thread runs asynchronously with respect to the calling thread returning from pthread_cancel().

RETURN VALUES

 

If successful, the pthread_cancel() function returns 0. Otherwise, an error number is returned to indicate the error.

ERRORS

 

The pthread_cancel() function may fail if:

ESRCH
No thread was found with an ID corresponding to that specified by the given thread ID, target_thread.

ATTRIBUTES

 

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPEATTRIBUTE VALUE
MT-LevelMT-Safe

SEE ALSO

 

cancellation(3THR), condition(3THR), pthread_cleanup_pop(3THR), pthread_cleanup_push(3THR), pthread_cond_wait(3THR), pthread_cond_timedwait(3THR), pthread_exit(3THR), pthread_join(3THR), pthread_setcancelstate(3THR), pthread_setcanceltype(3THR), pthread_testcancel(3THR), setjmp(3C), attributes(5)

NOTES

 

See cancellation(3THR) for a discussion of cancellation concepts.


SunOS 5.9Go To TopLast Changed 7 May 1998

 
      
      
Copyright 2002 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.