System Grab Bag

View all man pages from Linux (or from all projects)

Name

pthread_testcancel - request delivery of any pending cancelation request

Library

POSIX threads library ( libpthread ", " -lpthread )

Synopsis

#include <pthread.h> 
void pthread_testcancel(void); 

Description

Calling pthread_testcancel() creates a cancelation point within the calling thread, so that a thread that is otherwise executing code that contains no cancelation points will respond to a cancelation request.

If cancelability is disabled (using pthread_setcancelstate(3)), or no cancelation request is pending, then a call to pthread_testcancel() has no effect.

Return Value

This function does not return a value. If the calling thread is canceled as a consequence of a call to this function, then the function does not return.

Errors

This function always succeeds.

Attributes

For an explanation of the terms used in this section, see attributes(7). allbox; lbx lb lb T{ pthread_testcancel()
InterfaceAttributeValue
T}Thread safetyMT-Safe

Standards

POSIX.1-2008.

History

glibc 2.0. POSIX.1-2001.

Examples

See pthread_cleanup_push(3).

See Also

  1. pthread_cancel(3),
  2. pthread_cleanup_push(3),
  3. pthread_setcancelstate(3),
  4. pthreads(7)