Adding delegate method to XMPPStream to detect a "clean" disconnect (stream sent closing </stream:stream> stanza)

Author: robbiehanson

Core/XMPPStream.h

@@ -994,11 +994,31 @@ extern const NSTimeInterval XMPPStreamTimeoutNone;
 /**
  * This method is called if the disconnect method is called.
  * It may be used to determine if a disconnection was purposeful, or due to an error.
+ * 
+ * Note: A disconnect may be either "clean" or "dirty".
+ * A "clean" disconnect is when the stream sends the closing </stream:stream> stanza before disconnecting.
+ * A "dirty" disconnect is when the stream simply closes its TCP socket.
+ * In most cases it makes no difference how the disconnect occurs,
+ * but there are a few contexts in which the difference has various protocol implications.
+ * 
+ * @see xmppStreamDidSendClosingStreamStanza
 **/
 - (void)xmppStreamWasToldToDisconnect:(XMPPStream *)sender;
 
 /**
- * This methods is called if the XMPP Stream's connect times out
+ * This method is called after the stream has sent the closing </stream:stream> stanza.
+ * This signifies a "clean" disconnect.
+ * 
+ * Note: A disconnect may be either "clean" or "dirty".
+ * A "clean" disconnect is when the stream sends the closing </stream:stream> stanza before disconnecting.
+ * A "dirty" disconnect is when the stream simply closes its TCP socket.
+ * In most cases it makes no difference how the disconnect occurs,
+ * but there are a few contexts in which the difference has various protocol implications.
+**/
+- (void)xmppStreamDidSendClosingStreamStanza:(XMPPStream *)sender;
+
+/**
+ * This methods is called if the XMPP stream's connect times out.
 **/
 - (void)xmppStreamConnectDidTimeout:(XMPPStream *)sender;
 
@@ -1009,7 +1029,9 @@ extern const NSTimeInterval XMPPStreamTimeoutNone;
  * Some examples:
  * - The TCP socket was unexpectedly disconnected.
  * - The SRV resolution of the domain failed.
- * - Error parsing xml sent from server. 
+ * - Error parsing xml sent from server.
+ * 
+ * @see xmppStreamConnectDidTimeout:
 **/
 - (void)xmppStreamDidDisconnect:(XMPPStream *)sender withError:(NSError *)error;
 

Core/XMPPStream.m

@@ -41,8 +41,9 @@
 #define TAG_XMPP_READ_START         100
 #define TAG_XMPP_READ_STREAM        101
 #define TAG_XMPP_WRITE_START        200
-#define TAG_XMPP_WRITE_STREAM       201
-#define TAG_XMPP_WRITE_RECEIPT      202
+#define TAG_XMPP_WRITE_STOP         201
+#define TAG_XMPP_WRITE_STREAM       202
+#define TAG_XMPP_WRITE_RECEIPT      203
 
 // Define the timeouts (in seconds) for SRV
 #define TIMEOUT_SRV_RESOLUTION 30.0
@@ -1421,7 +1422,7 @@ - (void)disconnectAfterSending
 				XMPPLogSend(@"SEND: %@", termStr);
 				numberOfBytesSent += [termData length];
 
-				[asyncSocket writeData:termData withTimeout:TIMEOUT_XMPP_WRITE tag:TAG_XMPP_WRITE_STREAM];
+				[asyncSocket writeData:termData withTimeout:TIMEOUT_XMPP_WRITE tag:TAG_XMPP_WRITE_STOP];
 				[asyncSocket disconnectAfterWriting];
 
 				// Everthing will be handled in socketDidDisconnect:withError:
@@ -3970,6 +3971,10 @@ - (void)socket:(GCDAsyncSocket *)sock didWriteDataWithTag:(long)tag
 		[receipt signalSuccess];
 		[receipts removeObjectAtIndex:0];
 	}
+	else if (tag == TAG_XMPP_WRITE_STOP)
+	{
+		[multicastDelegate xmppStreamDidSendClosingStreamStanza:self];
+	}
 }
 
 /**