--- projects/cms/source/server/uk/org/iscream/cms/server/filter/TCPReaderInit.java	2001/01/18 23:13:36	1.12
+++ projects/cms/source/server/uk/org/iscream/cms/server/filter/TCPReaderInit.java	2001/01/28 05:34:38	1.13
@@ -16,7 +16,7 @@ import uk.ac.ukc.iscream.util.*;
  * This provides Host heartbeat functionality
  *
  * @author  $Author: tdb $
- * @version $Id: TCPReaderInit.java,v 1.12 2001/01/18 23:13:36 tdb Exp $
+ * @version $Id: TCPReaderInit.java,v 1.13 2001/01/28 05:34:38 tdb Exp $
  */
 class TCPReaderInit extends Thread {
 
@@ -25,22 +25,35 @@ class TCPReaderInit extends Thread {
     /**
      * The current CVS revision of this class
      */
-    public final String REVISION = "$Revision: 1.12 $";
+    public final String REVISION = "$Revision: 1.13 $";
     
 //---STATIC METHODS---
 
 //---CONSTRUCTORS---
-
+    
+    /**
+     * Construct a new TCPReaderInit.
+     *
+     * @param socket the Socket to which the host is connected
+     * @param queue the Queue to which we'll add data
+     * @throws IOException if something goes badly wrong
+     */
     public TCPReaderInit(Socket socket, Queue queue) throws IOException {
         _socket = socket;
         _queue = queue;
+        // setup the reader & writer
         _socketIn = new BufferedReader(new InputStreamReader(_socket.getInputStream()));
         _socketOut = new PrintWriter(_socket.getOutputStream());
         _logger.write(toString(), Logger.SYSINIT, "created");
     }
     
 //---PUBLIC METHODS---
-
+    
+    /**
+     * Main run method. Will communicate with the host, inform it
+     * if any updates to it's configuration are needed, and send
+     * a heartbeat packet into the system.
+     */
     public void run() {
         try {
             //variables