root/ext/xmlrpc/libxmlrpc/xmlrpc_introspection.h

INCLUDED FROM

   1 /*
   2   This file is part of libXMLRPC - a C library for xml-encoded function calls.
   3 
   4   Author: Dan Libby (dan@libby.com)
   5   Epinions.com may be contacted at feedback@epinions-inc.com
   6 */
   7 
   8 /*
   9   Copyright 2000 Epinions, Inc.
  10 
  11   Subject to the following 3 conditions, Epinions, Inc.  permits you, free
  12   of charge, to (a) use, copy, distribute, modify, perform and display this
  13   software and associated documentation files (the "Software"), and (b)
  14   permit others to whom the Software is furnished to do so as well.
  15 
  16   1) The above copyright notice and this permission notice shall be included
  17   without modification in all copies or substantial portions of the
  18   Software.
  19 
  20   2) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT ANY WARRANTY OR CONDITION OF
  21   ANY KIND, EXPRESS, IMPLIED OR STATUTORY, INCLUDING WITHOUT LIMITATION ANY
  22   IMPLIED WARRANTIES OF ACCURACY, MERCHANTABILITY, FITNESS FOR A PARTICULAR
  23   PURPOSE OR NONINFRINGEMENT.
  24 
  25   3) IN NO EVENT SHALL EPINIONS, INC. BE LIABLE FOR ANY DIRECT, INDIRECT,
  26   SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES OR LOST PROFITS ARISING OUT
  27   OF OR IN CONNECTION WITH THE SOFTWARE (HOWEVER ARISING, INCLUDING
  28   NEGLIGENCE), EVEN IF EPINIONS, INC.  IS AWARE OF THE POSSIBILITY OF SUCH
  29   DAMAGES.
  30 
  31 */
  32 
  33 /* IMPORTANT!
  34  *
  35  * only public (official API) things should be in this file. Anything else
  36  * should go in <group>_private.h, or in the appropriate .c file.
  37  */
  38 
  39 
  40 #ifndef __XI_INTROSPECTION_H
  41 /*
  42  * Avoid include redundancy.
  43  */
  44 #define __XI_INTROSPECTION_H
  45 
  46 /*----------------------------------------------------------------------------
  47  * xmlrpc_introspection.h
  48  *
  49  * Purpose:
  50  *   define public introspection API
  51  * Comments:
  52  */
  53 
  54 /*----------------------------------------------------------------------------
  55  * Constants
  56  */
  57  #define xi_token_params "params"
  58  #define xi_token_returns "returns"
  59  #define xi_token_related "related"
  60  #define xi_token_sub "sub"
  61 
  62 
  63 /*----------------------------------------------------------------------------
  64  * Includes
  65  */
  66 
  67 /*----------------------------------------------------------------------------
  68  * Structures
  69  */
  70 
  71  /****d* VALUE/XMLRPC_IntrospectionCallback
  72  * NAME
  73  *   XMLRPC_IntrospectionCallback
  74  * NOTES
  75  *   Function prototype for lazy documentation generation (not generated until requested).
  76  * SOURCE
  77  */
  78 typedef void (*XMLRPC_IntrospectionCallback)(XMLRPC_SERVER server, void* userData);
  79 /******/
  80 
  81 
  82 /*----------------------------------------------------------------------------
  83  * Globals
  84  */
  85 
  86 /*----------------------------------------------------------------------------
  87  * Functions
  88  */
  89 XMLRPC_VALUE XMLRPC_IntrospectionCreateDescription(const char* xml, XMLRPC_ERROR error);
  90 int XMLRPC_ServerAddIntrospectionData(XMLRPC_SERVER server, XMLRPC_VALUE desc);
  91 int XMLRPC_ServerRegisterIntrospectionCallback(XMLRPC_SERVER server, XMLRPC_IntrospectionCallback cb);
  92 
  93 /*----------------------------------------------------------------------------
  94  * Macros
  95  */
  96 
  97 
  98 #endif /* __XI_INTROSPECTION_H */
  99 
 100 
 101