Return to usleep.3 CVS log

Up to [cvs.NetBSD.org] / src / lib / libc / gen

Annotation of src/lib/libc/gen/usleep.3, Revision 1.12

1.12    ! wiz         1: .\"    $NetBSD: usleep.3,v 1.11 2000/08/21 23:23:23 soren Exp $
1.3       cgd         2: .\"
                      3: .\" Copyright (c) 1986, 1991, 1993
                      4: .\"    The Regents of the University of California.  All rights reserved.
1.1       cgd         5: .\"
                      6: .\" Redistribution and use in source and binary forms, with or without
                      7: .\" modification, are permitted provided that the following conditions
                      8: .\" are met:
                      9: .\" 1. Redistributions of source code must retain the above copyright
                     10: .\"    notice, this list of conditions and the following disclaimer.
                     11: .\" 2. Redistributions in binary form must reproduce the above copyright
                     12: .\"    notice, this list of conditions and the following disclaimer in the
                     13: .\"    documentation and/or other materials provided with the distribution.
                     14: .\" 3. All advertising materials mentioning features or use of this software
                     15: .\"    must display the following acknowledgement:
                     16: .\"    This product includes software developed by the University of
                     17: .\"    California, Berkeley and its contributors.
                     18: .\" 4. Neither the name of the University nor the names of its contributors
                     19: .\"    may be used to endorse or promote products derived from this software
                     20: .\"    without specific prior written permission.
                     21: .\"
                     22: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
                     23: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
                     24: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
                     25: .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
                     26: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
                     27: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
                     28: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
                     29: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
                     30: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
                     31: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
                     32: .\" SUCH DAMAGE.
                     33: .\"
1.3       cgd        34: .\"     @(#)usleep.3   8.1 (Berkeley) 6/4/93
1.1       cgd        35: .\"
1.3       cgd        36: .Dd June 4, 1993
1.1       cgd        37: .Dt USLEEP 3
1.10      garbled    38: .Os
1.1       cgd        39: .Sh NAME
                     40: .Nm usleep
                     41: .Nd suspend execution for interval of microseconds
1.9       perry      42: .Sh LIBRARY
                     43: .Lb libc
1.1       cgd        44: .Sh SYNOPSIS
                     45: .Fd #include <unistd.h>
1.8       kleink     46: .Ft int
                     47: .Fn usleep "useconds_t microseconds"
1.1       cgd        48: .Sh DESCRIPTION
                     49: The
1.3       cgd        50: .Fn usleep
1.1       cgd        51: function
                     52: suspends execution of the calling process
1.6       mikel      53: until either the number of microseconds specified by
1.1       cgd        54: .Fa microseconds
1.6       mikel      55: have elapsed or a signal is delivered to the calling process and its
                     56: action is to invoke a signal catching function or to terminate the
                     57: process.  The suspension time may be longer than requested due to the
                     58: scheduling of other activity by the system.
1.8       kleink     59: .Pp
                     60: The
                     61: .Fa microseconds
1.11      soren      62: argument must be less than 1,000,000.  If the value of
1.8       kleink     63: .Fa microseconds
                     64: is 0, then the call has no effect.
1.6       mikel      65: .Sh RETURN VALUE
1.8       kleink     66: On successful completition,
                     67: .Fn usleep
                     68: returns 0.  Otherwhise, it returns -1 and sets errno to indicate the error.
                     69: .Sh ERRORS
1.6       mikel      70: The
                     71: .Fn usleep
1.8       kleink     72: function may fail if:
1.12    ! wiz        73: .Bl -tag -width Er
1.8       kleink     74: .It Bq Er EINVAL
                     75: The
                     76: .Fa microseconds
                     77: interval specified 1,000,000 or more microseconds.
                     78: .El
1.1       cgd        79: .Sh SEE ALSO
1.5       jtc        80: .Xr nanosleep 2 ,
1.4       mikel      81: .Xr sleep 3
1.8       kleink     82: .Sh STANDARDS
                     83: The
                     84: .Fn usleep
                     85: function conforms to
                     86: .St -xpg4.2 .
1.1       cgd        87: .Sh HISTORY
                     88: The
                     89: .Fn usleep
1.12    ! wiz        90: function appeared in
1.1       cgd        91: .Bx 4.3 .