[GNUnet-SVN] r18591 - gnunet/src/include

[gnunet]

Author: grothoff
Date: 2011-12-14 14:36:23 +0100 (Wed, 14 Dec 2011)
New Revision: 18591

Modified:
   gnunet/src/include/gnunet_stream_lib.h
Log:
-api improvement

Modified: gnunet/src/include/gnunet_stream_lib.h
===================================================================
--- gnunet/src/include/gnunet_stream_lib.h      2011-12-14 13:32:40 UTC (rev 
18590)
+++ gnunet/src/include/gnunet_stream_lib.h      2011-12-14 13:36:23 UTC (rev 
18591)
@@ -211,8 +211,10 @@
  * @param status the status of the stream at the time this function is called
  * @param data traffic from the other side
  * @param size the number of bytes available in data read 
+ * @return number of bytes of processed from 'data' (any data remaining should 
be
+ *         given to the next time the read processor is called).
  */
-typedef void (*GNUNET_STREAM_DataProcessor) (void *cls,
+typedef size_t (*GNUNET_STREAM_DataProcessor) (void *cls,
                                             enum GNUNET_STREAM_Status status,
                                             const char *data,
                                             size_t size);
@@ -223,7 +225,7 @@
  *
  * @param socket the socket representing a stream
  * @param timeout the timeout period
- * @param proc function to call with data
+ * @param proc function to call with data (once only)
  * @param proc_cls the closure for proc
  * @return handle to cancel the operation
  */