original/man3/siginterrupt.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" References consulted:
  26 .\"     Linux libc source code
  27 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  28 .\"     386BSD man pages
  29 .\" Modified Sun Jul 25 10:40:51 1993 by Rik Faith (faith@cs.unc.edu)
  30 .\" Modified Sun Apr 14 16:20:34 1996 by Andries Brouwer (aeb@cwi.nl)
  31 .TH SIGINTERRUPT 3 2013-04-19 "" "Linux Programmer's Manual"
  32 .SH NAME
  33 siginterrupt \- allow signals to interrupt system calls
  34 .SH SYNOPSIS
  35 .nf
  36 .B #include <signal.h>
  37 .sp
  38 .BI "int siginterrupt(int " sig ", int " flag );
  39 .fi
  40 .sp
  41 .in -4n
  42 Feature Test Macro Requirements for glibc (see
  43 .BR feature_test_macros (7)):
  44 .in
  45 .sp
  46 .BR siginterrupt ():
  47 .ad l
  48 .RS 4
  49 _BSD_SOURCE || _XOPEN_SOURCE\ >=\ 500 ||
  50 _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED
  51 .br
  52 || /* Since glibc 2.12: */ _POSIX_C_SOURCE\ >=\ 200809L
  53 .RE
  54 .ad
  55 .SH DESCRIPTION
  56 The
  57 .BR siginterrupt ()
  58 function changes the restart behavior when
  59 a system call is interrupted by the signal \fIsig\fP.
  60 If the \fIflag\fP
  61 argument is false (0), then system calls will be restarted if interrupted
  62 by the specified signal \fIsig\fP.
  63 This is the default behavior in Linux.
  64 .PP
  65 If the \fIflag\fP argument is true (1) and no data has been transferred,
  66 then a system call interrupted by the signal \fIsig\fP will return \-1
  67 and \fIerrno\fP will be set to
  68 .BR EINTR .
  69 .PP
  70 If the \fIflag\fP argument is true (1) and data transfer has started,
  71 then the system call will be interrupted and will return the actual
  72 amount of data transferred.
  73 .SH RETURN VALUE
  74 The
  75 .BR siginterrupt ()
  76 function returns 0 on success.
  77 It returns \-1 if the
  78 signal number
  79 .I sig
  80 is invalid, with
  81 .I errno
  82 set to indicate the cause of the error.
  83 .SH ERRORS
  84 .TP
  85 .B EINVAL
  86 The specified signal number is invalid.
  87 .SH CONFORMING TO
  88 4.3BSD, POSIX.1-2001.
  89 POSIX.1-2008 marks
  90 .BR siginterrupt ()
  91 as obsolete, recommending the use of
  92 .BR sigaction (2)
  93 with the
  94 .B SA_RESTART
  95 flag instead.
  96 .SH SEE ALSO
  97 .BR signal (2)
  98 .SH COLOPHON
  99 This page is part of release 3.67 of the Linux
 100 .I man-pages
 101 project.
 102 A description of the project,
 103 information about reporting bugs,
 104 and the latest version of this page,
 105 can be found at
 106 \%http://www.kernel.org/doc/man\-pages/.