original/man3/usleep.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 1993-07-24 by Rik Faith (faith@cs.unc.edu)
  30 .\" Modified 2001-04-01 by aeb
  31 .\" Modified 2003-07-23 by aeb
  32 .\"
  33 .TH USLEEP 3  2010-12-03 "" "Linux Programmer's Manual"
  34 .SH NAME
  35 usleep \- suspend execution for microsecond intervals
  36 .SH SYNOPSIS
  37 .nf
  38 .B "#include <unistd.h>"
  39 .sp
  40 .BI "int usleep(useconds_t " usec );
  41 .fi
  42 .sp
  43 .in -4n
  44 Feature Test Macro Requirements for glibc (see
  45 .BR feature_test_macros (7)):
  46 .in
  47 .sp
  48 .BR usleep ():
  49 .ad l
  50 .RS 4
  51 .PD 0
  52 .TP 4
  53 Since glibc 2.12:
  54 .nf
  55 _BSD_SOURCE ||
  56     (_XOPEN_SOURCE\ >=\ 500 ||
  57         _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED) &&
  58     !(_POSIX_C_SOURCE\ >=\ 200809L || _XOPEN_SOURCE\ >=\ 700)
  59 .TP 4
  60 .fi
  61 Before glibc 2.12:
  62 _BSD_SOURCE || _XOPEN_SOURCE\ >=\ 500 ||
  63 _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED
  64 .PD
  65 .RE
  66 .ad b
  67 .SH DESCRIPTION
  68 The
  69 .BR usleep ()
  70 function suspends execution of the calling thread for
  71 (at least) \fIusec\fP microseconds.
  72 The sleep may be lengthened slightly
  73 by any system activity or by the time spent processing the call or by the
  74 granularity of system timers.
  75 .SH RETURN VALUE
  76 0 on success, \-1 on error.
  77 .SH ERRORS
  78 .TP
  79 .B EINTR
  80 Interrupted by a signal; see
  81 .BR signal (7).
  82 .TP
  83 .B EINVAL
  84 \fIusec\fP is not smaller than 1000000.
  85 (On systems where that is considered an error.)
  86 .SH CONFORMING TO
  87 4.3BSD, POSIX.1-2001.
  88 POSIX.1-2001 declares this function obsolete; use
  89 .BR nanosleep (2)
  90 instead.
  91 POSIX.1-2008 removes the specification of
  92 .BR usleep ().
  93
  94 On the original BSD implementation,
  95 and in glibc before version 2.2.2, the return type of this function is
  96 .IR void .
  97 The POSIX version returns
  98 .IR int ,
  99 and this is also the prototype used since glibc 2.2.2.
 100
 101 Only the
 102 .B EINVAL
 103 error return is documented by SUSv2 and POSIX.1-2001.
 104 .SH NOTES
 105 The type
 106 .I useconds_t
 107 is an unsigned integer type capable of holding integers
 108 in the range [0,1000000].
 109 Programs will be more portable
 110 if they never mention this type explicitly.
 111 Use
 112 .in +4n
 113 .nf
 114 .sp
 115 #include <unistd.h>
 116 \&...
 117     unsigned int usecs;
 118 \&...
 119     usleep(usecs);
 120 .fi
 121 .in
 122 .LP
 123 The interaction of this function with the
 124 .B SIGALRM
 125 signal, and with other timer functions such as
 126 .BR alarm (2),
 127 .BR sleep (3),
 128 .BR nanosleep (2),
 129 .BR setitimer (2),
 130 .BR timer_create (2),
 131 .BR timer_delete (2),
 132 .BR timer_getoverrun (2),
 133 .BR timer_gettime (2),
 134 .BR timer_settime (2),
 135 .BR ualarm (3)
 136 is unspecified.
 137 .SH SEE ALSO
 138 .BR alarm (2),
 139 .BR getitimer (2),
 140 .BR nanosleep (2),
 141 .BR select (2),
 142 .BR setitimer (2),
 143 .BR sleep (3),
 144 .BR ualarm (3),
 145 .BR time (7)