Use LoopingThread for Reader and Writer.

git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@11 542714f4-19e9-0310-aa3c-eee0fc999fb1

src/java/com/threerings/presents/client/Communicator.java

@@ -1,5 +1,5 @@
 //
-// $Id: Communicator.java,v 1.4 2001/05/29 03:27:59 mdb Exp $
+// $Id: Communicator.java,v 1.5 2001/05/30 23:51:39 mdb Exp $
 
 package com.samskivert.cocktail.cher.client;
 
@@ -7,6 +7,7 @@ import java.io.*;
 import java.net.Socket;
 import java.net.InetAddress;
 
+import com.samskivert.util.LoopingThread;
 import com.samskivert.util.Queue;
 
 import com.samskivert.cocktail.cher.Log;
@@ -38,7 +39,7 @@ import com.samskivert.cocktail.cher.util.Codes;
  * - write loop
  * </pre>
  */
-class Communicator
+public class Communicator
 {
     /**
      * Creates a new communicator instance which is associated with the
@@ -246,11 +247,10 @@ class Communicator
      * things, but the general flow of the reader thread is encapsulated
      * in this class.
      */
-    protected class Reader extends Thread
+    protected class Reader extends LoopingThread
     {
-        public void run ()
+        protected void willStart ()
         {
-            try {
             // first we connect and authenticate with the server
             try {
                 // connect to the server
@@ -265,33 +265,7 @@ class Communicator
                 // let the observers know that we've failed
                 _client.notifyObservers(Client.CLIENT_FAILED_TO_LOGON, e);
                 // and terminate our communicator thread
-                    return;
+                shutdown();
-                }
-
-                // now that we're authenticated, we manage the reading
-                // half of things by continuously reading messages from
-                // the socket and processing them
-                listen();
-
-            } finally {
-                // let the communicator know when we finally go away
-                readerDidExit();
-            }
-        }
-
-        /**
-         * Informs the reader thread that it's no longer running. The next
-         * time through the read loop, it will exit.
-         */
-        public synchronized void shutdown ()
-        {
-            _running = false;
-
-            // if we are not the reader thread, then we want to interrupt
-            // the reader thread as it may be blocked listening to the
-            // socket
-            if (Thread.currentThread() != this) {
-                interrupt();
             }
         }
 
@@ -329,8 +303,10 @@ class Communicator
             sendMessage(req);
 
             // now wait for the auth response
+            Log.info("Waiting for auth response.");
             AuthResponse rsp = (AuthResponse)receiveMessage();
             AuthResponseData data = rsp.getData();
+            Log.info("Got auth response: " + data);
             
             // if the auth request failed, we want to let the communicator
             // know by throwing a login exception
@@ -342,11 +318,13 @@ class Communicator
             logonSucceeded(data);
         }
 
-        protected void listen ()
+        // now that we're authenticated, we manage the reading
+        // half of things by continuously reading messages from
+        // the socket and processing them
+        protected void iterate ()
         {
             DownstreamMessage msg = null;
 
-            while (isRunning()) {
             try {
                 // read the next message from the socket
                 msg = receiveMessage();
@@ -356,13 +334,11 @@ class Communicator
 
             } catch (ObjectStreamException ose) {
                 Log.warning("Error decoding message: " + ose);
-                    // move on to the next message
 
             } catch (InterruptedIOException iioe) {
                 // somebody set up us the bomb! we've been interrupted
-                    // which means that we're being shut down, so we
+                // which means that we're being shut down, so we just
-                    // simply fall through and isRunning() will return
+                // report it and return from iterate() like a good monkey
-                    // false next time through the loop
                 Log.info("Reader thread woken up in time to die.");
 
             } catch (EOFException eofe) {
@@ -371,8 +347,7 @@ class Communicator
                 shutdown();
 
             } catch (IOException ioe) {
-                    // let the communicator know that our connection
+                // let the communicator know that our connection failed
-                    // failed
                 connectionFailed(ioe);
                 // and shut ourselves down
                 shutdown();
@@ -380,21 +355,22 @@ class Communicator
             } catch (Exception e) {
                 Log.warning("Error processing message [msg=" + msg +
                             ", error=" + e + "].");
-                    // move on to the next message
-                }
             }
         }
 
-        /**
+        protected void didShutdown ()
-         * Must access _running via this member function to ensure that we
-         * are Chapter 17 compliant.
-         */
-        protected synchronized boolean isRunning ()
         {
-            return _running;
+            // let the communicator know when we finally go away
+            readerDidExit();
         }
 
-        protected boolean _running = true;
+        protected void kick ()
+        {
+            // we want to interrupt the reader thread as it may be blocked
+            // listening to the socket; this is only called if the reader
+            // thread doesn't shut itself down
+            interrupt();
+        }
     }
 
     /**
@@ -402,12 +378,10 @@ class Communicator
      * to the <code>Communicator</code> class to do things, but the
      * general flow of the writer thread is encapsulated in this class.
      */
-    protected class Writer extends Thread
+    protected class Writer extends LoopingThread
     {
-        public void run ()
+        protected void iterate ()
         {
-            try {
-                while (isRunning()) {
             // fetch the next message from the queue
             UpstreamMessage msg = (UpstreamMessage)_msgq.get();
 
@@ -415,7 +389,7 @@ class Communicator
             // requested to exit, so we want to bail now rather
             // than continuing
             if (msg instanceof TerminationMessage) {
-                        break;
+                return;
             }
 
             try {
@@ -431,34 +405,17 @@ class Communicator
             }
         }
 
-            } finally {
+        protected void didShutdown ()
+        {
             writerDidExit();
         }
-        }
 
-        /**
+        protected void kick ()
-         * Informs the writer thread that it's no longer running. The next
-         * time through the write loop, it will exit.
-         */
-        public synchronized void shutdown ()
         {
-            _running = false;
-
             // post a bogus message to the outgoing queue to ensure that
             // the writer thread notices that it's time to go
             postMessage(new TerminationMessage());
         }
-
-        /**
-         * Must access _running via this member function to ensure that we
-         * are Chapter 17 compliant.
-         */
-        protected synchronized boolean isRunning ()
-        {
-            return _running;
-        }
-
-        protected boolean _running = true;
     }
 
     /** This is used to terminate the writer thread. */