fix bad free
[oweals/gnunet.git] / src / include / gnunet_sensor_service.h
index a31b20e5285781241e9863ebca348c16cadca2b2..c141def27072dd45ef4093456c9d052996466879 100644 (file)
@@ -1,32 +1,36 @@
 /*
       This file is part of GNUnet
-      (C) 
+      Copyright (C)
 
-      GNUnet is free software; you can redistribute it and/or modify
-      it under the terms of the GNU General Public License as published
-      by the Free Software Foundation; either version 3, or (at your
-      option) any later version.
+      GNUnet is free software: you can redistribute it and/or modify it
+      under the terms of the GNU Affero General Public License as published
+      by the Free Software Foundation, either version 3 of the License,
+      or (at your option) any later version.
 
       GNUnet is distributed in the hope that it will be useful, but
       WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-      General Public License for more details.
-
-      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.
+      Affero General Public License for more details.
+     
+      You should have received a copy of the GNU Affero General Public License
+      along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 /**
- * @file include/gnunet_sensor_service.h
- * @brief API to the sensor service
  * @author Omar Tarabai
+ *
+ * @file
+ * API to the sensor service
+ *
+ * @defgroup sensor  Sensor service
+ *
+ * @{
  */
+
 #ifndef GNUNET_SENSOR_SERVICE_H
 #define GNUNET_SENSOR_SERVICE_H
 
-#include "platform.h"
+#include "gnunet_common.h"
 #include "gnunet_util_lib.h"
 
 #ifdef __cplusplus
@@ -48,6 +52,11 @@ struct GNUNET_SENSOR_Handle;
  */
 struct GNUNET_SENSOR_IterateContext;
 
+/**
+ * Context of a force anomaly request
+ */
+struct GNUNET_SENSOR_ForceAnomalyContext;
+
 /**
  * Structure containing brief info about sensor
  */
@@ -145,6 +154,37 @@ GNUNET_SENSOR_iterate (struct GNUNET_SENSOR_Handle *h,
                                GNUNET_SENSOR_SensorIterateCB callback,
                                void *callback_cls);
 
+
+/**
+ * Cancel a force anomaly request.
+ *
+ * @param fa Force anomaly context returned by GNUNET_SENSOR_force_anomaly()
+ */
+void
+GNUNET_SENSOR_force_anomaly_cancel (struct GNUNET_SENSOR_ForceAnomalyContext
+                                    *fa);
+
+
+/**
+ * Force an anomaly status change on a given sensor. If the sensor reporting
+ * module is running, this will trigger the usual reporting logic, therefore,
+ * please only use this in a test environment.
+ *
+ * Also, if the sensor analysis module is running, it might conflict and cause
+ * undefined behaviour if it detects a real anomaly.
+ *
+ * @param h Service handle
+ * @param sensor_name Sensor name to set the anomaly status
+ * @param anomalous The desired status: #GNUNET_YES / #GNUNET_NO
+ * @param cont Continuation function to be called after the request is sent
+ * @param cont_cls Closure for cont
+ */
+struct GNUNET_SENSOR_ForceAnomalyContext *
+GNUNET_SENSOR_force_anomaly (struct GNUNET_SENSOR_Handle *h, char *sensor_name,
+                             int anomalous, GNUNET_SENSOR_Continuation cont,
+                             void *cont_cls);
+
+
 #if 0                           /* keep Emacsens' auto-indent happy */
 {
 #endif
@@ -153,3 +193,5 @@ GNUNET_SENSOR_iterate (struct GNUNET_SENSOR_Handle *h,
 #endif
 
 #endif
+
+/** @} */  /* end of group */