Return to boundary_fopen.3 CVS log

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

Annotation of embedaddon/libpdel/io/boundary_fopen.3, revision 1.1.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: boundary_fopen.3,v 1.9 2004/06/02 17:24:37 archie Exp $
                     39: .\"
                     40: .Dd April 22, 2002
                     41: .Dt BOUNDARY_FOPEN 3
                     42: .Os
                     43: .Sh NAME
                     44: .Nm boundary_fopen
                     45: .Nd read from a stream until a boundary string is matched
                     46: .Sh LIBRARY
                     47: PDEL Library (libpdel, \-lpdel)
                     48: .Sh SYNOPSIS
                     49: .In stdio.h
                     50: .In pdel/io/boundary_fp.h
                     51: .Ft "FILE *"
                     52: .Fn boundary_fopen "FILE *fp" "const char *boundary" "int closeit"
                     53: .Sh DESCRIPTION
                     54: .Fn boundary_fopen
                     55: creates a new read-only stream that reads data from the underlying stream
                     56: .Fa fp
                     57: until the
                     58: .Fa boundary
                     59: string is encountered, after which
                     60: .Dv EOF
                     61: is returned.
                     62: If the boundary string does not appear in the underlying stream input,
                     63: the entire input is passed through unaltered.
                     64: .Pp
                     65: When the boundary string appears, the last character readable from the
                     66: newly created boundary stream will be the character just before the first
                     67: character of the boundary string. 
                     68: Therefore, the boundary string itself does not appear in the input
                     69: from the boundary stream.
                     70: In no case are any characters beyond the last character of the boundary
                     71: string read out from the underlying stream, i.e.,
                     72: the last character read from the underlying stream will be
                     73: the last character of the boundary string.
                     74: .Pp
                     75: The boundary matching algorithm runs in linear time.
                     76: However, the
                     77: .Fa boundary
                     78: string is limited to 255 characters in length (not counting the
                     79: terminating '\\0' byte).
                     80: .Pp
                     81: .Xr fclose 3
                     82: should be used to close the returned stream.
                     83: The
                     84: .Fa closeit
                     85: parameter determines whether the underlying stream
                     86: .Fa fp
                     87: is also closed when the boundary stream is closed.
                     88: .Pp
                     89: Boundary streams are useful for online parsing of multipart
                     90: MIME document body parts as defined in RFC 2046.
                     91: .Sh RETURN VALUES
                     92: .Fn boundary_fopen
                     93: returns
                     94: .Dv NULL
                     95: to indicate an error, with
                     96: .Va errno
                     97: set appropriately.
                     98: .Sh SEE ALSO
                     99: .Xr count_fopen 3 ,
                    100: .Xr string_fp 3 ,
                    101: .Xr libpdel 3
                    102: .Rs
                    103: .%A N. Freed
                    104: .%A N. Borenstein
                    105: .%T "Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types"
                    106: .%O RFC 2046
                    107: .Re
                    108: .Sh HISTORY
                    109: The PDEL library was developed at Packet Design, LLC.
                    110: .Dv "http://www.packetdesign.com/"
                    111: .Sh AUTHORS
                    112: .An Archie Cobbs Aq archie@freebsd.org