adding number of preferences to allow iterating over preferences

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

diff --git a/src/include/gnunet_sensor_service.h b/src/include/gnunet_sensor_service.h
index e2ac40098d2f1834c52a4825c6c5112be27ff917..5caaafd98cfaffd02f2df96d38a44e169396433f 100644 (file)
--- a/src/include/gnunet_sensor_service.h
+++ b/src/include/gnunet_sensor_service.h
@@ -1,6 +1,6 @@
 /*
       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
@@ -43,6 +43,16 @@ extern "C"
  */
 struct GNUNET_SENSOR_Handle;
 
+/**
+ * Context for an iteration request.
+ */
+struct GNUNET_SENSOR_IterateContext;
+
+/**
+ * Context of a force anomaly request
+ */
+struct GNUNET_SENSOR_ForceAnomalyContext;
+
 /**
  * Structure containing brief info about sensor
  */
@@ -72,15 +82,16 @@ struct SensorInfoShort
 };
 
 /**
- * Type of an iterator over sensor definitions.
+ * Sensor iterate request callback.
  *
  * @param cls closure
- * @param hello hello message for the peer (can be NULL)
+ * @param sensor Brief sensor information
  * @param error message
  */
-typedef void (*GNUNET_SENSOR_SensorIteratorCB) (void *cls,
-                                             const struct SensorInfoShort *sensor,
-                                             const char *err_msg);
+typedef void (*GNUNET_SENSOR_SensorIterateCB) (void *cls,
+                                                const struct SensorInfoShort *
+                                                sensor, const char *err_msg);
+
 
 /**
  * Continuation called with a status result.
@@ -88,8 +99,17 @@ typedef void (*GNUNET_SENSOR_SensorIteratorCB) (void *cls,
  * @param cls closure
  * @param emsg error message, NULL on success
  */
-typedef void (*GNUNET_SENSOR_Continuation)(void *cls,
-               const char *emsg);
+typedef void (*GNUNET_SENSOR_Continuation) (void *cls, const char *emsg);
+
+
+/**
+ * Disconnect from the sensor service
+ *
+ * @param h handle to disconnect
+ */
+void
+GNUNET_SENSOR_disconnect (struct GNUNET_SENSOR_Handle *h);
+
 
 /**
  * Connect to the sensor service.
@@ -100,6 +120,66 @@ struct GNUNET_SENSOR_Handle *
 GNUNET_SENSOR_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
 
 
+/**
+ * Cancel an iteration request.
+ * This should be called before the iterate callback is called with a NULL value.
+ *
+ * @param ic context of the iterator to cancel
+ */
+void
+GNUNET_SENSOR_iterate_cancel (struct GNUNET_SENSOR_IterateContext
+                                     *ic);
+
+
+/**
+ * Get one or all sensors loaded by the sensor service.
+ * The callback will be called with each sensor received and once with a NULL
+ * value to signal end of iteration.
+ *
+ * @param h Handle to SENSOR service
+ * @param timeout how long to wait until timing out
+ * @param sensorname Name of the required sensor, NULL to get all
+ * @param callback the function to call for each sensor
+ * @param callback_cls closure for callback
+ * @return iterator context
+ */
+struct GNUNET_SENSOR_IterateContext *
+GNUNET_SENSOR_iterate (struct GNUNET_SENSOR_Handle *h,
+                               struct GNUNET_TIME_Relative timeout,
+                               const char *sensor_name,
+                               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