PTHREAD_CANCEL(3)

ИМЯ
pthread_cancel - посылает нити запрос отмены

ОБЗОР
#include <pthread.h>

int pthread_cancel(pthread_t thread);

Компилируется и компонуется вместе с -pthread.

ОПИСАНИЕ
Функция pthread_cancel() посылает нити thread запрос отмены. Отреагирует нити назначения и когда на запрос отмены зависит от двух атрибутов, которые управляют этой нитью: состояние и тип возможности отмены.

Состояние отменяемости нити, определённое в pthread_setcancelstate(3), может быть включено (по умолчанию у новых нитей) или выключено. Если отменяемость у нити выключена, то запрос отменяемости остаётся в очереди до тех пор, пока нить не включит отменяемость. Если отменяемость у нити включена, то когда произойдёт отмена определяется типом отменяемости.

Тип отменяемости нити, определённый в pthread_setcanceltype(3), может быть асинхронным или отложенным (по умолчанию у новых нитей). Асинхронная отменяемость означает, что нить может быть отменена в любое время (обычно, немедленно, но система не гарантирует этого). Отложенная отменяемость означает, что отмена будет задержана до тех пор, пока нить не вызовет функцию, являющуюся точкой отмены. Список функций, которые могут быть точками отмены, представлен в pthreads(7).

Когда выполняется запрошенная отмена, для thread выполняются следующие шаги (в таком порядке):

1.  Отмена поднимает очищающие обработчики (в обратном порядке их регистрации) и они вызываются (смотрите pthread_cleanup_push(3)).

2.  Вызываются деструкторы данных нити, в неопределённом порядке (смотрите pthread_key_create(3)).

3.  Нить завершается (смотрите pthread_exit(3)).

Приведённые выше шаги выполняются асинхронно по отношению к вызову pthread_cancel(); возвращаемое pthread_cancel() состояние всего лишь информирует вызывающего, что запрос отмены успешно попал в очередь.

После завершения отменённой нити, при объединении с этой нитью с помощью pthread_join(3) возвращается PTHREAD_CANCELED в качестве состояния выхода (объединение с нитью — единственный способ узнать о завершении отмены).

ВОЗВРАЩАЕМОЕ ЗНАЧЕНИЕ
При успешном выполнении pthread_cancel() возвращается 0; при ошибке возвращается ненулевой номер ошибки.

ОШИБКИ

ESRCH
    Нить с идентификатором thread не найдена.

АТРИБУТЫ
Описание терминов данного раздела смотрите в attributes(7).
Интерфейс | Атрибут | Значение
pthread_cancel() | Безвредность в нитях | MT-Safe

СООТВЕТСТВИЕ СТАНДАРТАМ
POSIX.1-2001, POSIX.1-2008.

ЗАМЕЧАНИЯ
В Linux отменяемость реализована с помощью сигналов. В реализации нитей NPTL для этой цели используется первый сигнал реального времени (т. е., сигнал). В LinuxThreads используется второй сигнал реального времени (если сигналы реального времени доступны, в противном случае используется SIGUSR2).

ПРИМЕР
Программа, представленная ниже, создаёт нить и затем отменяет её. Главная нить объединяется с отменённой нитью, чтобы получить состояние выхода PTHREAD_CANCELED. Далее представлен сеанс работы программы:

    $ ./a.out
    thread_func(): запущена; отмена выключена
    main(): отправляем запрос отмены
    thread_func(): для включения отмены
    main(): нить была отменена

  Исходный код программы
    #include <pthread.h>
    #include <stdio.h>
    #include <errno.h>
    #include <stdlib.h>
    #include <unistd.h>
    #define handle_error_en(en, msg) \
            do { errno = en; perror(msg); exit(EXIT_FAILURE); } while (0)
    static void *
    thread_func(void *ignored_argument)
    {
        int s;
        /* выключаем отмена на некоторое время для того, чтобы
           запрос на отмену не сработал сразу же */
        s = pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, NULL);
        if (s != 0)
            handle_error_en(s, "pthread_setcancelstate");
        printf("thread_func(): запущена; отмена выключена\n");
        sleep(5);
        printf("thread_func(): для включения отмены\n");
        s = pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL);
        if (s != 0)
            handle_error_en(s, "pthread_setcancelstate");
        /* sleep() является точкой отмены */
        sleep(1000);        /* должна произойти отмена во время сна */
        /* не должно до сюда дойти */
        printf("thread_func(): не отменена!\n");
        return NULL;
    }
    int
    main(void)
    {
        pthread_t thr;
        void *res;
        int s;
        /* запускаем нить, а затем посылаем ей запрос отмены */
        s = pthread_create(&thr, NULL, &thread_func, NULL);
        if (s != 0)
            handle_error_en(s, "pthread_create");
        sleep(2);           /* даём время нити запуститься */
        printf("main(): посылаем запрос отмены\n");
        s = pthread_cancel(thr);
        if (s != 0)
            handle_error_en(s, "pthread_cancel");
        /* присоединяемся к нити для получения её кода выхода */
        s = pthread_join(thr, &res);
        if (s != 0)
            handle_error_en(s, "pthread_join");
        if (res == PTHREAD_CANCELED)
            printf("main(): нить была отменена\n");
        else
            printf("main(): нить не была отменена, чего быть не должно!)\n");
        exit(EXIT_SUCCESS);
    }

СМОТРИТЕ ТАКЖЕ
pthread_cleanup_push(3), pthread_create(3), pthread_exit(3), pthread_join(3), pthread_key_create(3), pthread_setcancelstate(3), pthread_setcanceltype(3), pthread_testcancel(3), pthreads(7)