From 30861fb7ce19f59c8f23fa326e8d404f52e6062a Mon Sep 17 00:00:00 2001
From: Florian Schmaus <flo@geekplace.eu>
Date: Sat, 11 Jun 2016 16:31:39 +0200
Subject: [PATCH] Add comment about dropping SM state on stream errors.

Related to SMACK-696.
---
 .../main/java/org/jivesoftware/smack/tcp/XMPPTCPConnection.java | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/smack-tcp/src/main/java/org/jivesoftware/smack/tcp/XMPPTCPConnection.java b/smack-tcp/src/main/java/org/jivesoftware/smack/tcp/XMPPTCPConnection.java
index 8a24f038b..039a853db 100644
--- a/smack-tcp/src/main/java/org/jivesoftware/smack/tcp/XMPPTCPConnection.java
+++ b/smack-tcp/src/main/java/org/jivesoftware/smack/tcp/XMPPTCPConnection.java
@@ -879,6 +879,8 @@ public class XMPPTCPConnection extends AbstractXMPPConnection {
                 (packetWriter == null || packetWriter.done())) return;
 
         // Closes the connection temporary. A reconnection is possible
+        // Note that a connection listener of XMPPTCPConnection will drop the SM state in
+        // case the Exception is a StreamErrorException.
         instantShutdown();
 
         // Notify connection listeners of the error.