Return to timeout_fp.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / libpdel / io

Annotation of embedaddon/libpdel/io/timeout_fp.3, revision 1.1

1.1     ! misho       1: .\" Copyright (c) 2001-2002 Packet Design, LLC.
        !             2: .\" All rights reserved.
        !             3: .\" 
        !             4: .\" Subject to the following obligations and disclaimer of warranty,
        !             5: .\" use and redistribution of this software, in source or object code
        !             6: .\" forms, with or without modifications are expressly permitted by
        !             7: .\" Packet Design; provided, however, that:
        !             8: .\" 
        !             9: .\"    (i)  Any and all reproductions of the source or object code
        !            10: .\"         must include the copyright notice above and the following
        !            11: .\"         disclaimer of warranties; and
        !            12: .\"    (ii) No rights are granted, in any manner or form, to use
        !            13: .\"         Packet Design trademarks, including the mark "PACKET DESIGN"
        !            14: .\"         on advertising, endorsements, or otherwise except as such
        !            15: .\"         appears in the above copyright notice or in the software.
        !            16: .\" 
        !            17: .\" THIS SOFTWARE IS BEING PROVIDED BY PACKET DESIGN "AS IS", AND
        !            18: .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, PACKET DESIGN MAKES NO
        !            19: .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING
        !            20: .\" THIS SOFTWARE, INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED
        !            21: .\" WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
        !            22: .\" OR NON-INFRINGEMENT.  PACKET DESIGN DOES NOT WARRANT, GUARANTEE,
        !            23: .\" OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS
        !            24: .\" OF THE USE OF THIS SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY,
        !            25: .\" RELIABILITY OR OTHERWISE.  IN NO EVENT SHALL PACKET DESIGN BE
        !            26: .\" LIABLE FOR ANY DAMAGES RESULTING FROM OR ARISING OUT OF ANY USE
        !            27: .\" OF THIS SOFTWARE, INCLUDING WITHOUT LIMITATION, ANY DIRECT,
        !            28: .\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, PUNITIVE, OR CONSEQUENTIAL
        !            29: .\" DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, LOSS OF
        !            30: .\" USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY THEORY OF
        !            31: .\" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
        !            32: .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
        !            33: .\" THE USE OF THIS SOFTWARE, EVEN IF PACKET DESIGN IS ADVISED OF
        !            34: .\" THE POSSIBILITY OF SUCH DAMAGE.
        !            35: .\"
        !            36: .\" Author: Archie Cobbs <archie@freebsd.org>
        !            37: .\"
        !            38: .\" $Id: timeout_fp.3,v 1.6 2004/06/02 17:24:37 archie Exp $
        !            39: .\"
        !            40: .Dd April 22, 2002
        !            41: .Dt TIMEOUT_FDOPEN 3
        !            42: .Os
        !            43: .Sh NAME
        !            44: .Nm timeout_fdopen
        !            45: .Nd I/O streams with timeouts
        !            46: .Sh LIBRARY
        !            47: PDEL Library (libpdel, \-lpdel)
        !            48: .Sh SYNOPSIS
        !            49: .In sys/types.h
        !            50: .In stdio.h
        !            51: .In pdel/io/timeout_fp.h
        !            52: .Ft "FILE *"
        !            53: .Fn timeout_fdopen "int fd" "const char *mode" "int timeout"
        !            54: .Sh DESCRIPTION
        !            55: .Fn timeout_fdopen
        !            56: is equivalent to
        !            57: .Xr fdopen 3
        !            58: with the addition of an enforced timeout on read or write operations on the
        !            59: underlying file descriptor
        !            60: .Fa fd .
        !            61: .Pp
        !            62: If any read or write operation blocks for longer than
        !            63: .Fa timeout
        !            64: seconds, an error is returned with
        !            65: .Va errno
        !            66: set to
        !            67: .Er ETIMEDOUT .
        !            68: .Pp
        !            69: If
        !            70: .Fa timeout
        !            71: is zero or negative, no timeout is imposed and the behavior is identical to
        !            72: .Xr fdopen 3 .
        !            73: .Pp
        !            74: .Xr fclose 3
        !            75: should be used to close the returned stream.
        !            76: .Sh RETURN VALUES
        !            77: .Fn timeout_fdopen
        !            78: returns
        !            79: .Dv NULL
        !            80: to indicate an error, with
        !            81: .Va errno
        !            82: set appropriately.
        !            83: .Sh SEE ALSO
        !            84: .Xr fdopen 3 ,
        !            85: .Xr libpdel 3
        !            86: .Sh HISTORY
        !            87: The PDEL library was developed at Packet Design, LLC.
        !            88: .Dv "http://www.packetdesign.com/"
        !            89: .Sh AUTHORS
        !            90: .An Archie Cobbs Aq archie@freebsd.org