From f5ab7c6bf4eab568af18db84fe5d37fe43eb2144 Mon Sep 17 00:00:00 2001 From: Sree Harsha Totakura Date: Mon, 19 Nov 2012 13:07:19 +0000 Subject: [PATCH] - towards cleaner shutdowns --- src/include/gnunet_stream_lib.h | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/include/gnunet_stream_lib.h b/src/include/gnunet_stream_lib.h index 404844bce..674784fd9 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 */ -- 2.25.1