clientlib: Close connection after failed rekey

[silc.git] / lib / silccore / silcpacket.h

diff --git a/lib/silccore/silcpacket.h b/lib/silccore/silcpacket.h
index 0caf10d8c21bc8b54c245e3311265b8b785e6e9a..72046d768ef8f26237c70f29d054d1bbf57ec646 100644 (file)
--- a/lib/silccore/silcpacket.h
+++ b/lib/silccore/silcpacket.h
@@ -4,7 +4,7 @@
 
   Author: Pekka Riikonen <priikone@silcnet.org>
 
-  Copyright (C) 1997 - 2007 Pekka Riikonen
+  Copyright (C) 1997 - 2009 Pekka Riikonen
 
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
@@ -439,6 +439,10 @@ void silc_packet_engine_free_streams_list(SilcDList streams);
  *    stream.  After this function returns, packets can immediately be
  *    sent to and received from the stream.
  *
+ *    The `stream' will be owned by the packet stream and will be closed
+ *    and destroyed when the packet stream is destroyed.  If the packet
+ *    stream creation fails the `stream' is left intact.
+ *
  * NOTES
  *
  *    SilcPacketStream cannot be used with silc_stream_* routines (such as