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

[gnunet]

Author: harsha
Date: 2012-11-19 14:07:19 +0100 (Mon, 19 Nov 2012)
New Revision: 25048

Modified:
   gnunet/src/include/gnunet_stream_lib.h
Log:
- towards cleaner shutdowns

Modified: gnunet/src/include/gnunet_stream_lib.h
===================================================================
--- gnunet/src/include/gnunet_stream_lib.h      2012-11-19 13:07:04 UTC (rev 
25047)
+++ gnunet/src/include/gnunet_stream_lib.h      2012-11-19 13:07:19 UTC (rev 
25048)
@@ -197,7 +197,10 @@
 
 
 /**
- * Cancels a pending shutdown
+ * Cancels a pending shutdown. Note that the shutdown messages may already
+ * be sent and the stream is shutdown already for the operation given to
+ * GNUNET_STREAM_shutdown(). This function only clears up any retranmissions of
+ * shutdown messages and frees the shutdown handle.
  *
  * @param handle the shutdown handle returned from GNUNET_STREAM_shutdown
  */
@@ -207,7 +210,7 @@
 
 /**
  * Closes the stream and frees the associated state. The stream should be
- * shutdown before closing.
+ * shutdown for both reading and writing before closing.
  *
  * @param socket the stream socket
  */