Changeset 871 for trunk/autoquest-htmlmonitor/src/main/java/de/ugoe/cs/autoquest/htmlmonitor/HtmlMonitorServer.java

Timestamp:

10/12/12 15:08:45 (12 years ago)

Author:

pharms

Message:

• added some comments

File:

• trunk/autoquest-htmlmonitor/src/main/java/de/ugoe/cs/autoquest/htmlmonitor/HtmlMonitorServer.java (modified) (3 diffs)

trunk/autoquest-htmlmonitor/src/main/java/de/ugoe/cs/autoquest/htmlmonitor/HtmlMonitorServer.java

@@ -8 +8 @@
 
 /**
- * TODO: comment
+ * <p>
+ * this is the web server, that receives the client messages. It is initialized with a port on
+ * which it shall listen, as well as a message listener to forward the received messages to.
+ * Internally it starts a jetty web server with a single {@link HtmlMonitorServlet} to receive
+ * the messages.
+ * </p>
  * 
  * @author Patrick Harms
@@ -15 +20 @@
     
     /**
-     * 
+     * the port to listen on
      */
     private int port;
 
     /**
-     * 
+     * the jetty web server used for receiving messages
      */
     private Server server;
 
     /**
-     * 
+     * the message listener to forward the messages to
      */
     private HtmlMonitorMessageListener messageListener;
@@ -31 +36 @@
     /**
      * <p>
-     * TODO: comment
+     * initializes the server with the port to listen on and the message listener to forward
+     * the messages to.
      * </p>
      *
+     * @param port            the port to listen on
+     * @param messageListener the message listener to forward the messages to
      */
     HtmlMonitorServer(int port, HtmlMonitorMessageListener messageListener) {