svn commit: r1154563 - in /mina/sandbox/adc/ahc/mina3/src/main/java/org/apache/mina/link: Link.java LinkListener.java

[ad...@apache.org]

Author: adc
Date: Sat Aug  6 18:05:36 2011
New Revision: 1154563

URL: http://svn.apache.org/viewvc?rev=1154563&view=rev
Log:
Handy comments

Modified:
    mina/sandbox/adc/ahc/mina3/src/main/java/org/apache/mina/link/Link.java
    mina/sandbox/adc/ahc/mina3/src/main/java/org/apache/mina/link/LinkListener.java

Modified: mina/sandbox/adc/ahc/mina3/src/main/java/org/apache/mina/link/Link.java
URL: http://svn.apache.org/viewvc/mina/sandbox/adc/ahc/mina3/src/main/java/org/apache/mina/link/Link.java?rev=1154563&r1=1154562&r2=1154563&view=diff
==============================================================================
--- mina/sandbox/adc/ahc/mina3/src/main/java/org/apache/mina/link/Link.java (original)
+++ mina/sandbox/adc/ahc/mina3/src/main/java/org/apache/mina/link/Link.java Sat Aug  6 18:05:36 2011
@@ -29,6 +29,12 @@ import org.apache.mina.core.state.StateM
 
 
 /**
+ * A link connectivity protocol.
+ * <p/>
+ * P. LeMahieu and J. Bruck, "A Consistent History Link Connectivity
+ * Protocol," Proc. 17th ACM Symp. Principles of Distributed
+ * Computing, p. 309, July 1998.
+ *
  * @author <a href="http://mina.apache.org">Apache MINA Project</a>
  */
 public class Link extends StateMachineChannel<Token, Token, State, TimeoutEvent>
@@ -61,9 +67,14 @@ public class Link extends StateMachineCh
         this.listeners = listeners;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public void init() throws Exception
     {
+        LOG.trace("Initializing link");
+
         setState(State.UP);
         numTokens = 2;
 
@@ -72,6 +83,9 @@ public class Link extends StateMachineCh
         LOG.trace("Initialized link");
     }
 
+    /**
+     * A callback to notify the link that the connection has likely gone down.
+     */
     public void timeout()
     {
         LOG.debug("Timeout called");

Modified: mina/sandbox/adc/ahc/mina3/src/main/java/org/apache/mina/link/LinkListener.java
URL: http://svn.apache.org/viewvc/mina/sandbox/adc/ahc/mina3/src/main/java/org/apache/mina/link/LinkListener.java?rev=1154563&r1=1154562&r2=1154563&view=diff
==============================================================================
--- mina/sandbox/adc/ahc/mina3/src/main/java/org/apache/mina/link/LinkListener.java (original)
+++ mina/sandbox/adc/ahc/mina3/src/main/java/org/apache/mina/link/LinkListener.java Sat Aug  6 18:05:36 2011
@@ -19,11 +19,20 @@
 package org.apache.mina.link;
 
 /**
+ * Listeners who wish to be informed a link's state should implement this
+ * listener method.
+ *
  * @author <a href="http://mina.apache.org">Apache MINA Project</a>
  */
 public interface LinkListener
 {
+    /**
+     * The link has come up.
+     */
     public void up();
 
+    /**
+     * the link as gone down.
+     */
     public void down();
 }