Manual Pages for UNIX Operating System command usage for man pthread_cancel

Standard C Library Functions                   pthread_cancel(3C)



NAME
     pthread_cancel - cancel execution of a thread

SYNOPSIS
     cc -mt [ flag... ] file... -lpthread [ library... ]
     #include 

     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(5).


     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  des-
     tructor    functions    are    called   for   target_thread.
     target_thread is terminated when the last  destructor  func-
     tion returns.


     A thread acting on a cancellation request runs with all sig-
     nals  blocked.  All  thread termination functions, including
     cancellation cleanup handlers and thread-specific data  des-
     tructor functions, are called with all signals blocked.


     The cancellation processing in  target_thread runs asynchro-
     nously  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




SunOS 5.11           Last change: 2 Nov 2007                    1






Standard C Library Functions                   pthread_cancel(3C)



     See attributes(5) for descriptions of the  following  attri-
     butes:



     ____________________________________________________________
    |       ATTRIBUTE TYPE        |       ATTRIBUTE VALUE       |
    |_____________________________|_____________________________|
    | Interface Stability         | Committed                   |
    |_____________________________|_____________________________|
    | MT-Level                    | MT-Safe                     |
    |_____________________________|_____________________________|
    | Standard                    | See standards(5).           |
    |_____________________________|_____________________________|


SEE ALSO
     pthread_cleanup_pop(3C),           pthread_cleanup_push(3C),
     pthread_cond_wait(3C),           pthread_cond_timedwait(3C),
     pthread_exit(3C),                          pthread_join(3C),
     pthread_setcancelstate(3C),       pthread_setcanceltype(3C),
     pthread_testcancel(3C), setjmp(3C), attributes(5), cancella-
     tion(5), condition(5), standards(5)

NOTES
     See cancellation(5) for a discussion  of  cancellation  con-
     cepts.




























SunOS 5.11           Last change: 2 Nov 2007                    2