- towards cleaner shutdowns

git-svn-id: https://gnunet.org/svn/gnunet@25048 140774ce-b5e7-0310-ab8b-a85725594a96

1 files changed, 5 insertions, 2 deletions

diff --git a/src/include/gnunet_stream_lib.h b/src/include/gnunet_stream_lib.h
index 404844bce3..674784fd9c 100644
--- a/src/include/gnunet_stream_lib.h
+++ b/src/include/gnunet_stream_lib.h
@@ -197,7 +197,10 @@ GNUNET_STREAM_shutdown (struct GNUNET_STREAM_Socket *socket,
 
 
 /**
- * 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 @@ GNUNET_STREAM_shutdown_cancel (struct GNUNET_STREAM_ShutdownHandle *handle);
 
 /**
  * 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
  */