Return to http_mime.3 CVS log

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

libpdel

.\" Copyright (c) 2001-2002 Packet Design, LLC.
.\" All rights reserved.
.\" 
.\" Subject to the following obligations and disclaimer of warranty,
.\" use and redistribution of this software, in source or object code
.\" forms, with or without modifications are expressly permitted by
.\" Packet Design; provided, however, that:
.\" 
.\"    (i)  Any and all reproductions of the source or object code
.\"         must include the copyright notice above and the following
.\"         disclaimer of warranties; and
.\"    (ii) No rights are granted, in any manner or form, to use
.\"         Packet Design trademarks, including the mark "PACKET DESIGN"
.\"         on advertising, endorsements, or otherwise except as such
.\"         appears in the above copyright notice or in the software.
.\" 
.\" THIS SOFTWARE IS BEING PROVIDED BY PACKET DESIGN "AS IS", AND
.\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, PACKET DESIGN MAKES NO
.\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING
.\" THIS SOFTWARE, INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED
.\" WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
.\" OR NON-INFRINGEMENT.  PACKET DESIGN DOES NOT WARRANT, GUARANTEE,
.\" OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS
.\" OF THE USE OF THIS SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY,
.\" RELIABILITY OR OTHERWISE.  IN NO EVENT SHALL PACKET DESIGN BE
.\" LIABLE FOR ANY DAMAGES RESULTING FROM OR ARISING OUT OF ANY USE
.\" OF THIS SOFTWARE, INCLUDING WITHOUT LIMITATION, ANY DIRECT,
.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, PUNITIVE, OR CONSEQUENTIAL
.\" DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, LOSS OF
.\" USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY THEORY OF
.\" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
.\" THE USE OF THIS SOFTWARE, EVEN IF PACKET DESIGN IS ADVISED OF
.\" THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" Author: Archie Cobbs <archie@freebsd.org>
.\"
.\" $Id: http_mime.3,v 1.1.1.1 2012/02/21 23:25:53 misho Exp $
.\"
.Dd April 22, 2002
.Dt HTTP_MIME 3
.Os
.Sh NAME
.Nm http_mime
.Nd multi-part MIME suport
.Sh LIBRARY
PDEL Library (libpdel, \-lpdel)
.\"
.Sh SYNOPSIS
.\"
.In sys/types.h
.In stdio.h
.In netinet/in.h
.In openssl/ssl.h
.In pdel/http/http_defs.h
.In pdel/http/http_server.h
.Ft u_int
.Fn http_mime_multipart_get_count "struct mime_multipart *mp"
.Ft "struct mime_part *"
.Fn http_mime_multipart_get_part "struct mime_multipart *mp" "int index"
.Ft void
.Fn http_mime_multipart_free "struct mime_multipart **mpp"
.Ft "const char *"
.Fn http_mime_part_get_header "struct mime_part *part" "const char *name"
.Ft u_int
.Fn http_mime_part_get_length "struct mime_part *part"
.Ft "u_char *"
.Fn http_mime_part_get_data "struct mime_part *part"
.\"
.Sh DESCRIPTION
.\"
These functions handle multi-part MIME document data as returned by
.Xr http_request_read_mime_multipart 3 .
.Pp
A
.Li "struct mime_multipart"
represents an entire multi-part document, while a
.Li "struct mime_part"
represents a single part.
.Pp
.Fn http_mime_multipart_get_count
returns the number of parts in
.Fa mp .
.Pp
.Fn http_mime_multipart_get_part
retrieves the part with index
.Fa index ,
which must be less than the value returned by
.Fn http_mime_multipart_get_count .
.Pp
.Fn http_mime_multipart_free
frees a multi-part document.
Upon return.
.Fa "*mpp"
will be set to
.Dv NULL.
If
.Fa "*mpp"
is already
.Dv NULL
when
.Fn http_mime_multipart_free
is invoked, nothing happens.
.Pp
.Fn http_mime_part_get_header
retrieves a header having name
.Fa name
associated with the part
.Fa part .
.Pp
.Fn http_mime_part_get_length
returns the length in bytes of
.Fa part .
.Pp
.Fn http_mime_part_get_data
returns a pointer to the data of
.Fa part .
.Sh RETURN VALUES
.Fn http_mime_multipart_get_part
return
.Dv NULL
with
.Va errno
set to
.Er EINVAL
if
.Fa index
is out of range.
.Pp
.Fn http_mime_part_get_header
returns
.Dv NULL
with
.Va errno
set to
.Er ENOENT
if the header is not found.
.Sh SEE ALSO
.Xr http_client 3 ,
.Xr http_request 3 ,
.Xr http_response 3 ,
.Xr http_server 3 ,
.Xr libpdel 3
.Rs
.%A N. Freed
.%A N. Borenstein
.%T "Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types"
.%O RFC 2046
.Re
.Sh HISTORY
The PDEL library was developed at Packet Design, LLC.
.Dv "http://www.packetdesign.com/"
.Sh AUTHORS
.An Archie Cobbs Aq archie@freebsd.org