comments + tweaks

mythz · mythz · commit fe46c28f0e7a · 2017-03-04T21:56:45.000-05:00
diff --git a/src/AndroidClient/android/src/main/java/net/servicestack/client/sse/EventStream.java b/src/AndroidClient/android/src/main/java/net/servicestack/client/sse/EventStream.java
@@ -43,7 +43,8 @@ public void run() {
             client.errorsCount.set(0);
             readStream(is);
         } catch (InterruptedException ie){
-            Log.i("EventStream.run(): Caught InterruptedException"); //thrown by interruptBackgroundThread()
+            //Caused by stopBackgroundThread(), exit without restarting as the new bgThread does it
+            Log.i("EventStream.run(): Caught InterruptedException");
             return;
         } catch (Exception e) {
             Log.e("Error reading from event-stream, continuous errors: " + client.errorsCount.incrementAndGet(), e);
@@ -60,9 +61,10 @@ public void run() {
     protected int readFromStream(InputStream inputStream, byte[] buffer) throws IOException, InterruptedException {
         int len;
         while (true) {
+            //Checking if bytes are available to read to avoid performing a blocking read
             int available = inputStream.available();
             if (available > 0) break;
-            Thread.sleep(1);
+            Thread.sleep(1); //If bgThread was interrupted this throws an InterruptedException
         }
 
         len = inputStream.read(buffer);
diff --git a/src/AndroidClient/android/src/main/java/net/servicestack/client/sse/ServerEventsClient.java b/src/AndroidClient/android/src/main/java/net/servicestack/client/sse/ServerEventsClient.java
@@ -272,10 +272,10 @@ public String getConnectionDisplayName() {
             : "(not connected)";
     }
 
-    protected synchronized void interruptBackgroundThread() {
+    protected synchronized void stopBackgroundThread() {
         if (bgThread != null){
             bgEventStream.close();
-            bgThread.interrupt();
+            bgThread.interrupt(); //notify the bgThread to exit
             try {
                 bgThread.join();
             } catch (InterruptedException ignore) {}
@@ -288,7 +288,7 @@ protected EventStream createEventStream(){
     }
 
     public synchronized ServerEventsClient start(){
-        interruptBackgroundThread();
+        stopBackgroundThread();
 
         stopped.set(false);
         bgEventStream = createEventStream();
@@ -370,7 +370,7 @@ private synchronized void internalStop() {
         }
 
         connectionInfo = null;
-        interruptBackgroundThread();
+        stopBackgroundThread();
     }
 
     private void onCommandReceived(ServerEventMessage e) {
diff --git a/src/AndroidClient/client/src/main/java/net/servicestack/client/sse/EventStream.java b/src/AndroidClient/client/src/main/java/net/servicestack/client/sse/EventStream.java
@@ -43,7 +43,8 @@ public void run() {
             client.errorsCount.set(0);
             readStream(is);
         } catch (InterruptedException ie){
-            Log.i("EventStream.run(): Caught InterruptedException"); //thrown by interruptBackgroundThread()
+            //Caused by stopBackgroundThread(), exit without restarting as the new bgThread does it
+            Log.i("EventStream.run(): Caught InterruptedException");
             return;
         } catch (Exception e) {
             Log.e("Error reading from event-stream, continuous errors: " + client.errorsCount.incrementAndGet(), e);
@@ -60,9 +61,10 @@ public void run() {
     protected int readFromStream(InputStream inputStream, byte[] buffer) throws IOException, InterruptedException {
         int len;
         while (true) {
+            //Checking if bytes are available to read to avoid performing a blocking read
             int available = inputStream.available();
             if (available > 0) break;
-            Thread.sleep(1);
+            Thread.sleep(1); //If bgThread was interrupted this throws an InterruptedException
         }
 
         len = inputStream.read(buffer);
diff --git a/src/AndroidClient/client/src/main/java/net/servicestack/client/sse/ServerEventsClient.java b/src/AndroidClient/client/src/main/java/net/servicestack/client/sse/ServerEventsClient.java
@@ -272,10 +272,10 @@ public String getConnectionDisplayName() {
             : "(not connected)";
     }
 
-    protected synchronized void interruptBackgroundThread() {
+    protected synchronized void stopBackgroundThread() {
         if (bgThread != null){
             bgEventStream.close();
-            bgThread.interrupt();
+            bgThread.interrupt(); //notify the bgThread to exit
             try {
                 bgThread.join();
             } catch (InterruptedException ignore) {}
@@ -288,7 +288,7 @@ protected EventStream createEventStream(){
     }
 
     public synchronized ServerEventsClient start(){
-        interruptBackgroundThread();
+        stopBackgroundThread();
 
         stopped.set(false);
         bgEventStream = createEventStream();
@@ -370,7 +370,7 @@ private synchronized void internalStop() {
         }
 
         connectionInfo = null;
-        interruptBackgroundThread();
+        stopBackgroundThread();
     }
 
     private void onCommandReceived(ServerEventMessage e) {

Original file line number	Diff line number	Diff line change
`@@ -272,10 +272,10 @@ public String getConnectionDisplayName() {`
`272`	`272`	`: "(not connected)";`
`273`	`273`	`}`
`274`	`274`
`275`		`- protected synchronized void interruptBackgroundThread() {`
	`275`	`+ protected synchronized void stopBackgroundThread() {`
`276`	`276`	`if (bgThread != null){`
`277`	`277`	`bgEventStream.close();`
`278`		`- bgThread.interrupt();`
	`278`	`+ bgThread.interrupt(); //notify the bgThread to exit`
`279`	`279`	`try {`
`280`	`280`	`bgThread.join();`
`281`	`281`	`} catch (InterruptedException ignore) {}`
`@@ -288,7 +288,7 @@ protected EventStream createEventStream(){`
`288`	`288`	`}`
`289`	`289`
`290`	`290`	`public synchronized ServerEventsClient start(){`
`291`		`- interruptBackgroundThread();`
	`291`	`+ stopBackgroundThread();`
`292`	`292`
`293`	`293`	`stopped.set(false);`
`294`	`294`	`bgEventStream = createEventStream();`
`@@ -370,7 +370,7 @@ private synchronized void internalStop() {`
`370`	`370`	`}`
`371`	`371`
`372`	`372`	`connectionInfo = null;`
`373`		`- interruptBackgroundThread();`
	`373`	`+ stopBackgroundThread();`
`374`	`374`	`}`
`375`	`375`
`376`	`376`	`private void onCommandReceived(ServerEventMessage e) {`