Return to mime.h CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / libaitwww / inc

Annotation of libaitwww/inc/mime.h, revision 1.2

1.1       misho       1: /*************************************************************************
                      2: * (C) 2012 AITNET ltd - Sofia/Bulgaria - <misho@aitnet.org>
                      3: *  by Michael Pounov <misho@elwix.org>
                      4: *
                      5: * $Author: misho $
1.2     ! misho       6: * $Id: mime.h,v 1.1.1.1.14.1 2013/05/26 20:30:42 misho Exp $
1.1       misho       7: *
                      8: **************************************************************************
                      9: The ELWIX and AITNET software is distributed under the following
                     10: terms:
                     11: 
                     12: All of the documentation and software included in the ELWIX and AITNET
                     13: Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>
                     14: 
1.2     ! misho      15: Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013
1.1       misho      16:        by Michael Pounov <misho@elwix.org>.  All rights reserved.
                     17: 
                     18: Redistribution and use in source and binary forms, with or without
                     19: modification, are permitted provided that the following conditions
                     20: are met:
                     21: 1. Redistributions of source code must retain the above copyright
                     22:    notice, this list of conditions and the following disclaimer.
                     23: 2. Redistributions in binary form must reproduce the above copyright
                     24:    notice, this list of conditions and the following disclaimer in the
                     25:    documentation and/or other materials provided with the distribution.
                     26: 3. All advertising materials mentioning features or use of this software
                     27:    must display the following acknowledgement:
                     28: This product includes software developed by Michael Pounov <misho@elwix.org>
                     29: ELWIX - Embedded LightWeight unIX and its contributors.
                     30: 4. Neither the name of AITNET nor the names of its contributors
                     31:    may be used to endorse or promote products derived from this software
                     32:    without specific prior written permission.
                     33: 
                     34: THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND
                     35: ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
                     36: IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
                     37: ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
                     38: FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
                     39: DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
                     40: OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
                     41: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
                     42: LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
                     43: OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
                     44: SUCH DAMAGE.
                     45: */
                     46: #ifndef __MIME_H
                     47: #define __MIME_H
                     48: 
                     49: 
                     50: /*
                     51:  * mime_parseMultiPart() - Parse multi part MIME message
                     52:  *
                     53:  * @str = String
                     54:  * @len = String length
                     55:  * @bd = Boundary tag
                     56:  * @end = End of parsed part
                     57:  * return: NULL error or !=NULL allocated MIME session
                     58:  */
                     59: mime_t *mime_parseMultiPart(const char *str, size_t len, const char *bd, const char **end);
                     60: /*
                     61:  * mime_close() - Close MIME session and free all resources
                     62:  *
                     63:  * @mime = Inited mime session
                     64:  * return: none
                     65:  */
                     66: void mime_close(mime_t ** __restrict mime);
                     67: /*
                     68:  * mime_getValue() - Get value from MIME header
                     69:  *
                     70:  * @m = Mime part
                     71:  * @name = Header name
                     72:  * return: NULL not found or !=NULL value
                     73:  */
1.2     ! misho      74: const char *mime_getValue(struct tagMIME * __restrict m, const char *name);
1.1       misho      75: /*
                     76:  * mime_readPart() Read and parse MIME part
                     77:  *
                     78:  * @m = Mime part
                     79:  * @str = String
                     80:  * @len = String length
                     81:  * return: -1 error or 0 ok
                     82:  */
                     83: int mime_readPart(struct tagMIME * __restrict m, const char *str, size_t len);
                     84: /*
                     85:  * mime_parseHeader() - Parse MIME header pairs
                     86:  *
                     87:  * @m = Mime part
                     88:  * @str = String
                     89:  * @len = String length
                     90:  * @end = End of parsed part
                     91:  * return: -1 error or 0 ok
                     92:  */
                     93: int mime_parseHeader(struct tagMIME * __restrict m, const char *str, 
                     94:                size_t len, const char **end);
                     95: /*
                     96:  * mime_calcRawSize() - Calculate estimated memory for data from parsed MIME part
                     97:  *
                     98:  * @m = Mime part
                     99:  * return: -1 error or >-1 data size in mime part
                    100:  */
                    101: int mime_calcRawSize(struct tagMIME * __restrict m);
                    102: /*
                    103:  * mime_getRawData() - Get ready parsed data from MIME part body
                    104:  *
                    105:  * @m = Mime part
                    106:  * @str = output data buffer
                    107:  * @len = output data buffer length
                    108:  * return: -1 error or >-1 data length in output buffer
                    109:  */
                    110: int mime_getRawData(struct tagMIME * __restrict m, char * __restrict str, int len);
                    111: 
                    112: 
                    113: #endif