src/include/gnunet_rest_plugin.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2012-2015 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20 /**
  21  * @author Martin Schanzenbach
  22  * @file include/gnunet_rest_plugin.h
  23  * @brief GNUnet service REST plugin header
  24  *
  25  */
  26 #ifndef GNUNET_REST_PLUGIN_H
  27 #define GNUNET_REST_PLUGIN_H
  28
  29 #include "gnunet_util_lib.h"
  30
  31 #ifdef __cplusplus
  32 extern "C"
  33 {
  34 #if 0                           /* keep Emacsens' auto-indent happy */
  35 }
  36 #endif
  37 #endif
  38
  39 /**
  40  * Iterator called on obtained result for a REST result.
  41  *
  42  * @param cls closure
  43  * @param data REST result
  44  * @param data_len length of result
  45  * @param status status code (HTTP)
  46  */
  47 typedef void (*GNUNET_REST_ResultProcessor) (void *cls,
  48                           const char *data,
  49                           size_t data_len,
  50                           int status);
  51
  52 /**
  53  * @brief struct returned by the initialization function of the plugin
  54  */
  55 struct GNUNET_REST_Plugin
  56 {
  57
  58   /**
  59    *
  60    * The closure of the plugin
  61    *
  62    */
  63   void *cls;
  64
  65   /**
  66    * Plugin name. Used as the namespace for the API.
  67    * e.g. http://hostname:port/<name>
  68    */
  69   char *name;
  70
  71   /**
  72    * Function to process a REST call
  73    *
  74    * @param method the HTTP method called
  75    * @param url the relative url accessed
  76    * @param data the REST data (can be NULL)
  77    * @param data_size the length of the data
  78    * @param proc the callback for result
  79    * @param proc_cls closure for callback
  80    */
  81   void (*process_request) (const char *method,
  82                           const char *url,
  83                           const char *data,
  84                           size_t data_size,
  85                           GNUNET_REST_ResultProcessor proc,
  86                           void *proc_cls);
  87
  88 };
  89
  90
  91 #if 0                           /* keep Emacsens' auto-indent happy */
  92 {
  93 #endif
  94 #ifdef __cplusplus
  95 }
  96 #endif
  97
  98 /* end of gnunet_rest_plugin.h */
  99 #endif
 100