Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
PTHREAD_CANCEL(3)      FreeBSD Library Functions Manual	     PTHREAD_CANCEL(3)

NAME
     pthread_cancel -- cancel execution	of a thread

SYNOPSIS
     #include <pthread.h>

     int
     pthread_cancel(pthread_t thread);

DESCRIPTION
     The pthread_cancel() function requests that thread	be cancelled.  The
     target thread's cancelability state and type determines when the cancel-
     lation takes effect.  When	the cancellation is acted on, the cancellation
     cleanup handlers for thread are called.  When the last cancellation
     cleanup handler returns, the thread-specific data destructor functions
     will be called for	thread.	 When the last destructor function returns,
     thread will be terminated.

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

     A status of PTHREAD_CANCELED is made available to any threads joining
     with the target.  The symbolic constant PTHREAD_CANCELED expands to a
     constant expression of type (void *) whose	value matches no pointer to an
     object in memory nor the value NULL.

RETURN VALUES
     If	successful, the	pthread_cancel() functions will	return zero.  Other-
     wise an error number will be returned to indicate the error.

ERRORS
     pthread_cancel() will fail	if:

     [ESRCH]		No thread could	be found corresponding to that speci-
			fied by	the given thread ID.

SEE ALSO
     pthread_cleanup_pop(3), pthread_cleanup_push(3), pthread_exit(3),
     pthread_join(3), pthread_setcancelstate(3), pthread_setcanceltype(3),
     pthread_testcancel(3)

STANDARDS
     pthread_cancel() conforms to ISO/IEC 9945-1:1996 ("POSIX.1").

FreeBSD	13.0			 June 5, 2013			  FreeBSD 13.0

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUES | ERRORS | SEE ALSO | STANDARDS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=pthread_cancel&sektion=3&manpath=OpenBSD+6.9>

home | help