Return to xml.h CVS log

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

Annotation of embedaddon/libpdel/http/servlet/xml.h, revision 1.1

1.1     ! misho       1: 
        !             2: /*
        !             3:  * Copyright (c) 2001-2002 Packet Design, LLC.
        !             4:  * All rights reserved.
        !             5:  * 
        !             6:  * Subject to the following obligations and disclaimer of warranty,
        !             7:  * use and redistribution of this software, in source or object code
        !             8:  * forms, with or without modifications are expressly permitted by
        !             9:  * Packet Design; provided, however, that:
        !            10:  * 
        !            11:  *    (i)  Any and all reproductions of the source or object code
        !            12:  *         must include the copyright notice above and the following
        !            13:  *         disclaimer of warranties; and
        !            14:  *    (ii) No rights are granted, in any manner or form, to use
        !            15:  *         Packet Design trademarks, including the mark "PACKET DESIGN"
        !            16:  *         on advertising, endorsements, or otherwise except as such
        !            17:  *         appears in the above copyright notice or in the software.
        !            18:  * 
        !            19:  * THIS SOFTWARE IS BEING PROVIDED BY PACKET DESIGN "AS IS", AND
        !            20:  * TO THE MAXIMUM EXTENT PERMITTED BY LAW, PACKET DESIGN MAKES NO
        !            21:  * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING
        !            22:  * THIS SOFTWARE, INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED
        !            23:  * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
        !            24:  * OR NON-INFRINGEMENT.  PACKET DESIGN DOES NOT WARRANT, GUARANTEE,
        !            25:  * OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS
        !            26:  * OF THE USE OF THIS SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY,
        !            27:  * RELIABILITY OR OTHERWISE.  IN NO EVENT SHALL PACKET DESIGN BE
        !            28:  * LIABLE FOR ANY DAMAGES RESULTING FROM OR ARISING OUT OF ANY USE
        !            29:  * OF THIS SOFTWARE, INCLUDING WITHOUT LIMITATION, ANY DIRECT,
        !            30:  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, PUNITIVE, OR CONSEQUENTIAL
        !            31:  * DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, LOSS OF
        !            32:  * USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY THEORY OF
        !            33:  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
        !            34:  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
        !            35:  * THE USE OF THIS SOFTWARE, EVEN IF PACKET DESIGN IS ADVISED OF
        !            36:  * THE POSSIBILITY OF SUCH DAMAGE.
        !            37:  *
        !            38:  * Author: Archie Cobbs <archie@freebsd.org>
        !            39:  */
        !            40: 
        !            41: #ifndef _PDEL_HTTP_SERVLET_XML_H_
        !            42: #define _PDEL_HTTP_SERVLET_XML_H_
        !            43: 
        !            44: struct http_request;
        !            45: struct http_servlet_xml_info;
        !            46: 
        !            47: /*
        !            48:  * User-supplied handler for http_servlet_xml. Should return the
        !            49:  * reply structure (having type info->rtype), or NULL (and set errno)
        !            50:  * if there was an error.
        !            51:  *
        !            52:  * Parameters
        !            53:  *
        !            54:  *     arg             User-supplied cookie
        !            55:  *     payload         Incoming request structure (do not free)
        !            56:  *     pattrs          Incoming request XML document element attributes
        !            57:  *     rattrs          Reply XML document element attributes (if any)
        !            58:  *     mtype           Memory type with which to allocate reply and *rattrsp
        !            59:  */
        !            60: typedef void   *http_servlet_xml_handler_t(void *arg,
        !            61:                        struct http_request *req, const void *payload,
        !            62:                        const char *pattrs, char **rattrsp, const char *mtype);
        !            63: 
        !            64: /*
        !            65:  * Information required by http_servlet_xml_create().
        !            66:  *
        !            67:  *     handler         User-supplied handler function
        !            68:  *     ptag            Request XML document element tag expected
        !            69:  *     ptype           Payload type expected
        !            70:  *     rtag            Reply XML document element tag
        !            71:  *     rtype           Reply type returned by handler
        !            72:  *     allow_post      Allow POST queries
        !            73:  *     allow_get       Allow GET queries (payload and pattrs will be NULL)
        !            74:  *     logger          Logging function
        !            75:  *     flags           Flags for structs_xml_output()
        !            76:  */
        !            77: struct http_servlet_xml_info {
        !            78:        http_servlet_xml_handler_t      *handler;       /* user handler */
        !            79:        const char                      *ptag;          /* payload doc elem */
        !            80:        const struct structs_type       *ptype;         /* payload type */
        !            81:        const char                      *rtag;          /* reply doc elem */
        !            82:        const struct structs_type       *rtype;         /* reply type */
        !            83:        u_char                          allow_post;     /* allow POST */
        !            84:        u_char                          allow_get;      /* allow GET */
        !            85:        http_logger_t                   *logger;        /* loggging function */
        !            86:        int                             flags;          /* output flags */
        !            87: };
        !            88: 
        !            89: __BEGIN_DECLS
        !            90: 
        !            91: /*
        !            92:  * Create a new XML servlet.
        !            93:  */
        !            94: extern struct  http_servlet *http_servlet_xml_create(
        !            95:                        const struct http_servlet_xml_info *info,
        !            96:                        void *arg, void (*destroy)(void *));
        !            97: 
        !            98: __END_DECLS
        !            99: 
        !           100: #endif /* _PDEL_HTTP_SERVLET_XML_H_ */
        !           101: