SET service: accurate results for symmetric mode

[oweals/gnunet.git] / src / include / gnunet_rest_lib.h

diff --git a/src/include/gnunet_rest_lib.h b/src/include/gnunet_rest_lib.h
index 19a0168e554573eb48f896b7800f0d17c06ae6c8..a449d7deea66b0a25d655ccffd369bcc5284d793 100644 (file)
--- a/src/include/gnunet_rest_lib.h
+++ b/src/include/gnunet_rest_lib.h
@@ -14,8 +14,8 @@
 
       You should have received a copy of the GNU General Public License
       along with GNUnet; see the file COPYING.  If not, write to the
-      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-      Boston, MA 02111-1307, USA.
+      Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+      Boston, MA 02110-1301, USA.
  */
 
 /**
@@ -36,6 +36,52 @@
 
 #define GNUNET_REST_JSONAPI_KEY_TYPE "type"
 
+#define GNUNET_REST_HANDLER_END {NULL, NULL, NULL}
+
+struct RestConnectionDataHandle
+{
+  struct GNUNET_CONTAINER_MultiHashMap *url_param_map;
+  const char *method;
+  const char *url;
+  const char *data;
+  size_t data_size;
+
+};
+
+struct GNUNET_REST_RestConnectionHandler
+{
+  /**
+   * Http method to handle
+   */
+  const char *method;
+
+  /**
+   * Namespace to handle
+   */
+  const char *namespace;
+
+  /**
+   * callback handler
+   */
+  void (*proc) (struct RestConnectionDataHandle *handle,
+                const char *url,
+                void *cls);
+
+};
+
+
+/**
+ * Iterator called on obtained result for a REST result.
+ *
+ * @param cls closure
+ * @param resp the response
+ * @param status status code (HTTP)
+ */
+typedef void (*GNUNET_REST_ResultProcessor) (void *cls,
+                                             struct MHD_Response *resp,
+                                             int status);
+
+
 /**
  * Resource structs for JSON API
  */
@@ -44,7 +90,7 @@ struct JsonApiResource;
 /**
  * Responses for JSON API
  */
-struct JsonApiResponse;
+struct JsonApiObject;
 
 /**
  * Create a JSON API resource
@@ -78,7 +124,42 @@ int
 GNUNET_REST_jsonapi_resource_add_attr (const struct JsonApiResource *resource,
                                        const char* key,
                                        json_t *json);
+/**
+ * Read a JSON API attribute
+ *
+ * @param res the JSON resource
+ * @param key the key for the attribute
+ * @return the json attr
+ */
+json_t*
+GNUNET_REST_jsonapi_resource_read_attr (const struct JsonApiResource *resource,
+                                       const char* key);
+
 
+/**
+ * Check a JSON API resource id
+ *
+ * @param res the JSON resource
+ * @param id the expected id
+ * @return GNUNET_YES if id matches
+ */
+int
+GNUNET_REST_jsonapi_resource_check_id (const struct JsonApiResource *resource,
+                                       const char* id);
+
+
+/**
+ * Check a JSON API resource type
+ *
+ * @param res the JSON resource
+ * @param type the expected type
+ * @return GNUNET_YES if id matches
+ */
+int
+GNUNET_REST_jsonapi_resource_check_type (const struct JsonApiResource *resource,
+                                         const char* type);
+
+  
 /**
  * Create a JSON API primary data
  *
@@ -86,9 +167,20 @@ GNUNET_REST_jsonapi_resource_add_attr (const struct JsonApiResource *resource,
  * @param id the JSON API resource id
  * @return a new JSON API resource or NULL on error.
  */
-struct JsonApiResponse*
-GNUNET_REST_jsonapi_response_new ();
+struct JsonApiObject*
+GNUNET_REST_jsonapi_object_new ();
+
+
+/**
+ * Create a JSON API primary data from a string
+ *
+ * @param data the string of the JSON API data
+ * @return a new JSON API resource or NULL on error.
+ */
+struct JsonApiObject*
+GNUNET_REST_jsonapi_object_parse (const char* data);
 
+  
 /**
  * Delete a JSON API primary data
  *
@@ -97,7 +189,7 @@ GNUNET_REST_jsonapi_response_new ();
  * @return a new JSON API resource or NULL on error.
  */
 void
-GNUNET_REST_jsonapi_response_delete (struct JsonApiResponse *resp);
+GNUNET_REST_jsonapi_object_delete (struct JsonApiObject *resp);
 
 /**
  * Add a JSON API resource to primary data
@@ -107,8 +199,27 @@ GNUNET_REST_jsonapi_response_delete (struct JsonApiResponse *resp);
  * @return the new number of resources
  */
 void
-GNUNET_REST_jsonapi_response_resource_add (struct JsonApiResponse *resp,
+GNUNET_REST_jsonapi_object_resource_add (struct JsonApiObject *resp,
                                            struct JsonApiResource *res);
+/**
+ * Get a JSON API object resource count
+ *
+ * @param resp the JSON API object
+ * @return the number of resources
+ */
+int
+GNUNET_REST_jsonapi_object_resource_count (struct JsonApiObject *resp);
+
+/**
+ * Get a JSON API object resource num
+ *
+ * @param resp the JSON API object
+ * @param num the number of the resource
+ * @return the resource
+ */
+struct JsonApiResource*
+GNUNET_REST_jsonapi_object_get_resource (struct JsonApiObject *resp, int num);
+
 
 /**
  * Add a JSON API resource to primary data
@@ -118,7 +229,7 @@ GNUNET_REST_jsonapi_response_resource_add (struct JsonApiResponse *resp,
  * @return the new number of resources
  */
 void
-GNUNET_REST_jsonapi_data_resource_remove (struct JsonApiResponse *resp,
+GNUNET_REST_jsonapi_data_resource_remove (struct JsonApiObject *resp,
                                           struct JsonApiResource *res);
 
 /**
@@ -129,7 +240,7 @@ GNUNET_REST_jsonapi_data_resource_remove (struct JsonApiResponse *resp,
  * @return GNUNET_SYSERR on error else GNUNET_OK
  */
 int
-GNUNET_REST_jsonapi_data_serialize (const struct JsonApiResponse *resp,
+GNUNET_REST_jsonapi_data_serialize (const struct JsonApiObject *resp,
                                     char **result);
 
 /**
@@ -152,5 +263,9 @@ GNUNET_REST_namespace_match (const char *url, const char *namespace);
 GNUNET_REST_create_json_response (const char *data);
 
 
+int
+GNUNET_REST_handle_request (struct RestConnectionDataHandle *conn,
+                            const struct GNUNET_REST_RestConnectionHandler *handlers,
+                            void *cls);
 
 #endif