original/man3/siginterrupt.3

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