1 files changed, 31 insertions, 14 deletions

diff --git a/src/include/gnunet_sensor_service.h b/src/include/gnunet_sensor_service.h
index 4ef2885e6..a31b20e52 100644
--- a/src/include/gnunet_sensor_service.h
+++ b/src/include/gnunet_sensor_service.h
@@ -44,6 +44,11 @@ extern "C"
 struct GNUNET_SENSOR_Handle;
 
 /**
+ * Context for an iteration request.
+ */
+struct GNUNET_SENSOR_IterateContext;
+
+/**
  * Structure containing brief info about sensor
  */
 struct SensorInfoShort
@@ -72,13 +77,13 @@ 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,
+typedef void (*GNUNET_SENSOR_SensorIterateCB) (void *cls,
                                                 const struct SensorInfoShort *
                                                 sensor, const char *err_msg);
 
@@ -93,6 +98,15 @@ 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.
  *
  * @return NULL on error
@@ -102,30 +116,33 @@ GNUNET_SENSOR_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
 
 
 /**
- * Disconnect from the sensor service
+ * Cancel an iteration request.
+ * This should be called before the iterate callback is called with a NULL value.
  *
- * @param h handle to disconnect
+ * @param ic context of the iterator to cancel
  */
 void
-GNUNET_SENSOR_disconnect (struct GNUNET_SENSOR_Handle *h);
+GNUNET_SENSOR_iterate_cancel (struct GNUNET_SENSOR_IterateContext
+                                     *ic);
 
 
 /**
- * Client asking to iterate all available sensors
+ * 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 information on one sensor only, can be NULL to get all
- * @param sensorname_len length of the sensorname parameter
- * @param callback the method to call for each sensor
+ * @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_SensorIteratorContext *
-GNUNET_SENSOR_iterate_sensors (struct GNUNET_SENSOR_Handle *h,
+struct GNUNET_SENSOR_IterateContext *
+GNUNET_SENSOR_iterate (struct GNUNET_SENSOR_Handle *h,
                                struct GNUNET_TIME_Relative timeout,
-                               const char *sensorname, size_t sensorname_len,
-                               GNUNET_SENSOR_SensorIteratorCB callback,
+                               const char *sensor_name,
+                               GNUNET_SENSOR_SensorIterateCB callback,
                                void *callback_cls);
 
 #if 0                           /* keep Emacsens' auto-indent happy */