cleaning up set handlers, eliminating 2nd level demultiplexing and improving use...
[oweals/gnunet.git] / src / include / gnunet_my_lib.h
index 534a4db40a38c412dc33643120a7208624772fb7..f8ea01490c3ba0f3033402e40cdfccfb954d2765 100644 (file)
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet
-     Copyright (C) 2012 GNUnet e.V.
+     Copyright (C) 2016 GNUnet e.V.
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
@@ -19,6 +19,7 @@
 */
 /**
  * @author Christian Grothoff
+ * @author Christophe Genevey
  *
  * @file
  * Helper library to access a MySQL database
@@ -73,7 +74,7 @@ typedef int
  */
 typedef void
 (*GNUNET_MY_QueryCleanup)(void *cls,
-                           struct GNUNET_MY_QueryParam *qp);
+                           MYSQL_BIND *qbind);
 /**
  * Information we pass to #GNUNET_MY_exec_prepared() to
  * initialize the arguments of the prepared statement.
@@ -123,7 +124,6 @@ struct GNUNET_MY_QueryParam
 #define GNUNET_MY_query_param_end { NULL, NULL, NULL, 0, NULL, 0 }
 
 
-
 /**
  * Generate query parameter for a buffer @a ptr of
  * @a ptr_size bytes.FG
@@ -135,6 +135,7 @@ struct GNUNET_MY_QueryParam
 GNUNET_MY_query_param_fixed_size (const void *ptr,
                                  size_t ptr_size);
 
+
 /**
  * Run a prepared SELECT statement.
  *
@@ -146,7 +147,7 @@ GNUNET_MY_query_param_fixed_size (const void *ptr,
 int
 GNUNET_MY_exec_prepared (struct GNUNET_MYSQL_Context *mc,
                          struct GNUNET_MYSQL_StatementHandle *sh,
-                         const struct GNUNET_MY_QueryParam *params);
+                         struct GNUNET_MY_QueryParam *params);
 
 
 /**
@@ -245,6 +246,11 @@ struct GNUNET_MY_ResultSpec
    */
   unsigned long mysql_bind_output_length;
 
+  /**
+   * Memory for MySQL to notify us about NULL values.
+   */
+  my_bool is_null;
+
 };
 
 
@@ -253,7 +259,7 @@ struct GNUNET_MY_ResultSpec
  *
  * @return array last entry for the result specification to use
  */
-#define GNUNET_MY_result_spec_end { NULL, NULL, NULL, 0, NULL, 0 }
+#define GNUNET_MY_result_spec_end { NULL, NULL, NULL, 0, NULL, 0, 0 }
 
 
 
@@ -304,7 +310,7 @@ GNUNET_MY_query_param_rsa_public_key (const struct GNUNET_CRYPTO_RsaPublicKey *x
 struct GNUNET_MY_QueryParam
 GNUNET_MY_query_param_rsa_signature (const struct GNUNET_CRYPTO_RsaSignature *x);
 
-/**q
+/**
   * Generate query parameter for an absolute time value.
   * The database must store a 64-bit integer.
   *
@@ -314,6 +320,7 @@ GNUNET_MY_query_param_rsa_signature (const struct GNUNET_CRYPTO_RsaSignature *x)
 struct GNUNET_MY_QueryParam
 GNUNET_MY_query_param_absolute_time (const struct GNUNET_TIME_Absolute *x);
 
+
 /**
   * Generate query parameter for an absolute time value.
   * The database must store a 64-bit integer.
@@ -358,36 +365,33 @@ GNUNET_MY_query_param_uint64 (const uint64_t *x);
 
 
 /**
- * FIXME.
+ * Variable-size result expected
  *
+ * @param[out] dst where to store the result, allocated
+ * @param[out] sptr where to store the size of @a dst
+ * @return array entru for the result specification to use
  */
-
- /**
-  * Variable-size result expected
-  *
-  * @param[out] dst where to store the result, allocated
-  * @param[out] sptr where to store the size of @a dst
-  * @return array entru for the result specification to use
-  */
 struct GNUNET_MY_ResultSpec
 GNUNET_MY_result_spec_variable_size (void **dst,
-                                    size_t *ptr_size);
+                                     size_t *ptr_size);
+
 /**
 * RSA public key expected
 *
 * @param name name of the field in the table
 * @param[out] rsa where to store the result
 * @return array entry for the result specification to use
 */
+ * RSA public key expected
+ *
+ * @param name name of the field in the table
+ * @param[out] rsa where to store the result
+ * @return array entry for the result specification to use
+ */
 struct GNUNET_MY_ResultSpec
 GNUNET_MY_result_spec_rsa_public_key (struct GNUNET_CRYPTO_RsaPublicKey **rsa);
 
+
 /**
 * RSA signature expected.
 *
 * @param[out] sig where to store the result;
 * @return array entry for the result specification to use
 */
+ * RSA signature expected.
+ *
+ * @param[out] sig where to store the result;
+ * @return array entry for the result specification to use
+ */
 struct GNUNET_MY_ResultSpec
 GNUNET_MY_result_spec_rsa_signature (struct GNUNET_CRYPTO_RsaSignature **sig);
 
@@ -468,9 +472,11 @@ GNUNET_MY_extract_result (struct GNUNET_MYSQL_StatementHandle *sh,
  * #GNUNET_MY_exect_prepared().
  *
  * @param qp query specification to clean up
+ * @param qbind mysql query
  */
 void
-GNUNET_MY_cleanup_query (struct GNUNET_MY_QueryParam *qp);
+GNUNET_MY_cleanup_query (struct GNUNET_MY_QueryParam *qp,
+                         MYSQL_BIND *qbind);
 
 
 /**