[GNUnet-SVN] r32837 - in gnunet-java/src/main: java/org/gnunet/consensus java/org/gnunet/mesh java/org/gnunet/mesh/messages resources/org/gnunet/construct

[gnunet]

Author: dold
Date: 2014-03-31 02:29:01 +0200 (Mon, 31 Mar 2014)
New Revision: 32837

Added:
   gnunet-java/src/main/java/org/gnunet/mesh/messages/
   gnunet-java/src/main/java/org/gnunet/mesh/messages/ClientConnectMessage.java
   gnunet-java/src/main/java/org/gnunet/mesh/messages/LocalAckMessage.java
   gnunet-java/src/main/java/org/gnunet/mesh/messages/TunnelCreateMessage.java
   gnunet-java/src/main/java/org/gnunet/mesh/messages/TunnelDestroyMessage.java
Removed:
   gnunet-java/src/main/java/org/gnunet/mesh/ClientConnectMessage.java
   gnunet-java/src/main/java/org/gnunet/mesh/LocalAckMessage.java
   gnunet-java/src/main/java/org/gnunet/mesh/TunnelCreateMessage.java
   gnunet-java/src/main/java/org/gnunet/mesh/TunnelDestroyMessage.java
Modified:
   gnunet-java/src/main/java/org/gnunet/consensus/Consensus.java
   gnunet-java/src/main/java/org/gnunet/consensus/ConsensusCallback.java
   gnunet-java/src/main/java/org/gnunet/consensus/ConsensusElement.java
   gnunet-java/src/main/java/org/gnunet/consensus/InsertDoneCallback.java
   gnunet-java/src/main/java/org/gnunet/mesh/Mesh.java
   gnunet-java/src/main/resources/org/gnunet/construct/MsgMap.txt
Log:
docs

Modified: gnunet-java/src/main/java/org/gnunet/consensus/Consensus.java
===================================================================
--- gnunet-java/src/main/java/org/gnunet/consensus/Consensus.java       
2014-03-31 00:16:22 UTC (rev 32836)
+++ gnunet-java/src/main/java/org/gnunet/consensus/Consensus.java       
2014-03-31 00:29:01 UTC (rev 32837)
@@ -103,7 +103,6 @@
         client.send(m);
     }
 
-
     /**
      * Insert an element into the consensus set.
      *

Modified: gnunet-java/src/main/java/org/gnunet/consensus/ConsensusCallback.java
===================================================================
--- gnunet-java/src/main/java/org/gnunet/consensus/ConsensusCallback.java       
2014-03-31 00:16:22 UTC (rev 32836)
+++ gnunet-java/src/main/java/org/gnunet/consensus/ConsensusCallback.java       
2014-03-31 00:29:01 UTC (rev 32837)
@@ -20,7 +20,20 @@
 
 package org.gnunet.consensus;
 
+/**
+ * Callback for new elements and finished consensus.
+ */
 public interface ConsensusCallback {
+    /**
+     * Called when a new element arrives.
+     *
+     * @param element element that arrived.
+     */
     void onElement(ConsensusElement element);
+
+    /**
+     * Called when all elements have arrived. The 'onElement' method
+     * will not be called after 'onDone'.
+     */
     void onDone();
 }

Modified: gnunet-java/src/main/java/org/gnunet/consensus/ConsensusElement.java
===================================================================
--- gnunet-java/src/main/java/org/gnunet/consensus/ConsensusElement.java        
2014-03-31 00:16:22 UTC (rev 32836)
+++ gnunet-java/src/main/java/org/gnunet/consensus/ConsensusElement.java        
2014-03-31 00:29:01 UTC (rev 32837)
@@ -21,6 +21,9 @@
 package org.gnunet.consensus;
 
 
+/**
+ * Represents elements of the consensus set.
+ */
 public class ConsensusElement {
     /**
      * Type of the element.
@@ -34,6 +37,12 @@
      */
     public byte[] data;
 
+    /**
+     * Create a new element with the given data and given type.
+     *
+     * @param data data for the element, may not be larger than 2^16 bytes.
+     * @param elementType type of the element
+     */
     public ConsensusElement(byte[] data, int elementType) {
         this.data = data;
         this.elementType = elementType;

Modified: gnunet-java/src/main/java/org/gnunet/consensus/InsertDoneCallback.java
===================================================================
--- gnunet-java/src/main/java/org/gnunet/consensus/InsertDoneCallback.java      
2014-03-31 00:16:22 UTC (rev 32836)
+++ gnunet-java/src/main/java/org/gnunet/consensus/InsertDoneCallback.java      
2014-03-31 00:29:01 UTC (rev 32837)
@@ -20,6 +20,13 @@
 
 package org.gnunet.consensus;
 
+/**
+ * Callback for notifying the client that an element has been sent
+ * to the service.
+ */
 public interface InsertDoneCallback {
+    /**
+     * Called when an element has been sent to the service.
+     */
     void onInsertDone();
 }

Deleted: gnunet-java/src/main/java/org/gnunet/mesh/ClientConnectMessage.java
===================================================================
--- gnunet-java/src/main/java/org/gnunet/mesh/ClientConnectMessage.java 
2014-03-31 00:16:22 UTC (rev 32836)
+++ gnunet-java/src/main/java/org/gnunet/mesh/ClientConnectMessage.java 
2014-03-31 00:29:01 UTC (rev 32837)
@@ -1,18 +0,0 @@
-package org.gnunet.mesh;
-
-import org.gnunet.construct.IntegerFill;
-import org.gnunet.construct.UnionCase;
-import org.gnunet.util.GnunetMessage;
-
-/**
- * Allows a client to register with the service.
- *
- * Direction: client -> service
- *
- * @author Florian Dold
- */
address@hidden(272)
-public class ClientConnectMessage implements GnunetMessage.Body {
-    @IntegerFill(signed = false, bitSize = 32)
-    public int[] applicationList;
-}

Deleted: gnunet-java/src/main/java/org/gnunet/mesh/LocalAckMessage.java
===================================================================
--- gnunet-java/src/main/java/org/gnunet/mesh/LocalAckMessage.java      
2014-03-31 00:16:22 UTC (rev 32836)
+++ gnunet-java/src/main/java/org/gnunet/mesh/LocalAckMessage.java      
2014-03-31 00:29:01 UTC (rev 32837)
@@ -1,16 +0,0 @@
-package org.gnunet.mesh;
-
-import org.gnunet.construct.UInt32;
-import org.gnunet.construct.UnionCase;
-import org.gnunet.util.GnunetMessage;
-
-/**
- * ...
- *
- * @author Florian Dold
- */
address@hidden(286)
-public class LocalAckMessage implements GnunetMessage.Body {
-    @UInt32
-    public long tid;
-}

Modified: gnunet-java/src/main/java/org/gnunet/mesh/Mesh.java
===================================================================
--- gnunet-java/src/main/java/org/gnunet/mesh/Mesh.java 2014-03-31 00:16:22 UTC 
(rev 32836)
+++ gnunet-java/src/main/java/org/gnunet/mesh/Mesh.java 2014-03-31 00:29:01 UTC 
(rev 32837)
@@ -21,6 +21,10 @@
 package org.gnunet.mesh;
 
 import org.gnunet.construct.Construct;
+import org.gnunet.mesh.messages.ClientConnectMessage;
+import org.gnunet.mesh.messages.LocalAckMessage;
+import org.gnunet.mesh.messages.TunnelCreateMessage;
+import org.gnunet.mesh.messages.TunnelDestroyMessage;
 import org.gnunet.mq.Envelope;
 import org.gnunet.mq.MessageQueue;
 import org.gnunet.mq.NotifySentHandler;
@@ -32,9 +36,7 @@
 import java.util.Map;
 
 /**
- * Mesh API
- *
- * @author Florian Dold
+ * Connection to the mesh service.
  */
 public class Mesh {
     /**

Deleted: gnunet-java/src/main/java/org/gnunet/mesh/TunnelCreateMessage.java
===================================================================
--- gnunet-java/src/main/java/org/gnunet/mesh/TunnelCreateMessage.java  
2014-03-31 00:16:22 UTC (rev 32836)
+++ gnunet-java/src/main/java/org/gnunet/mesh/TunnelCreateMessage.java  
2014-03-31 00:29:01 UTC (rev 32837)
@@ -1,27 +0,0 @@
-package org.gnunet.mesh;
-
-import org.gnunet.construct.NestedMessage;
-import org.gnunet.construct.UInt32;
-import org.gnunet.construct.UnionCase;
-import org.gnunet.util.GnunetMessage;
-import org.gnunet.util.PeerIdentity;
-
-/**
- * FIXME
- *
- * @author Florian Dold
- */
address@hidden(273)
-public class TunnelCreateMessage implements GnunetMessage.Body {
-    @UInt32
-    public long tunnelId;
-
-    @NestedMessage(optional = false)
-    public PeerIdentity otherEnd;
-
-    @UInt32
-    public int port;
-
-    @UInt32
-    public int opt;
-}

Deleted: gnunet-java/src/main/java/org/gnunet/mesh/TunnelDestroyMessage.java
===================================================================
--- gnunet-java/src/main/java/org/gnunet/mesh/TunnelDestroyMessage.java 
2014-03-31 00:16:22 UTC (rev 32836)
+++ gnunet-java/src/main/java/org/gnunet/mesh/TunnelDestroyMessage.java 
2014-03-31 00:29:01 UTC (rev 32837)
@@ -1,26 +0,0 @@
-package org.gnunet.mesh;
-
-import org.gnunet.construct.FixedSizeIntegerArray;
-import org.gnunet.construct.UInt32;
-import org.gnunet.construct.UnionCase;
-import org.gnunet.util.GnunetMessage;
-
-/**
- * ...
- *
- * @author Florian Dold
- */
address@hidden(274)
-public class TunnelDestroyMessage implements GnunetMessage.Body {
-    @UInt32
-    public long tunnelId;
-
-    @FixedSizeIntegerArray(bitSize = 8, signed = false, length = 32)
-    public byte[] reserved;
-
-    @UInt32
-    public int port;
-
-    @UInt32
-    public int opt;
-}

Copied: 
gnunet-java/src/main/java/org/gnunet/mesh/messages/ClientConnectMessage.java 
(from rev 32831, 
gnunet-java/src/main/java/org/gnunet/mesh/ClientConnectMessage.java)
===================================================================
--- 
gnunet-java/src/main/java/org/gnunet/mesh/messages/ClientConnectMessage.java    
                            (rev 0)
+++ 
gnunet-java/src/main/java/org/gnunet/mesh/messages/ClientConnectMessage.java    
    2014-03-31 00:29:01 UTC (rev 32837)
@@ -0,0 +1,18 @@
+package org.gnunet.mesh.messages;
+
+import org.gnunet.construct.IntegerFill;
+import org.gnunet.construct.UnionCase;
+import org.gnunet.util.GnunetMessage;
+
+/**
+ * Allows a client to register with the service.
+ *
+ * Direction: client -> service
+ *
+ * @author Florian Dold
+ */
address@hidden(272)
+public class ClientConnectMessage implements GnunetMessage.Body {
+    @IntegerFill(signed = false, bitSize = 32)
+    public int[] applicationList;
+}

Copied: gnunet-java/src/main/java/org/gnunet/mesh/messages/LocalAckMessage.java 
(from rev 32831, gnunet-java/src/main/java/org/gnunet/mesh/LocalAckMessage.java)
===================================================================
--- gnunet-java/src/main/java/org/gnunet/mesh/messages/LocalAckMessage.java     
                        (rev 0)
+++ gnunet-java/src/main/java/org/gnunet/mesh/messages/LocalAckMessage.java     
2014-03-31 00:29:01 UTC (rev 32837)
@@ -0,0 +1,16 @@
+package org.gnunet.mesh.messages;
+
+import org.gnunet.construct.UInt32;
+import org.gnunet.construct.UnionCase;
+import org.gnunet.util.GnunetMessage;
+
+/**
+ * ...
+ *
+ * @author Florian Dold
+ */
address@hidden(286)
+public class LocalAckMessage implements GnunetMessage.Body {
+    @UInt32
+    public long tid;
+}

Copied: 
gnunet-java/src/main/java/org/gnunet/mesh/messages/TunnelCreateMessage.java 
(from rev 32831, 
gnunet-java/src/main/java/org/gnunet/mesh/TunnelCreateMessage.java)
===================================================================
--- gnunet-java/src/main/java/org/gnunet/mesh/messages/TunnelCreateMessage.java 
                        (rev 0)
+++ gnunet-java/src/main/java/org/gnunet/mesh/messages/TunnelCreateMessage.java 
2014-03-31 00:29:01 UTC (rev 32837)
@@ -0,0 +1,27 @@
+package org.gnunet.mesh.messages;
+
+import org.gnunet.construct.NestedMessage;
+import org.gnunet.construct.UInt32;
+import org.gnunet.construct.UnionCase;
+import org.gnunet.util.GnunetMessage;
+import org.gnunet.util.PeerIdentity;
+
+/**
+ * FIXME
+ *
+ * @author Florian Dold
+ */
address@hidden(273)
+public class TunnelCreateMessage implements GnunetMessage.Body {
+    @UInt32
+    public long tunnelId;
+
+    @NestedMessage(optional = false)
+    public PeerIdentity otherEnd;
+
+    @UInt32
+    public int port;
+
+    @UInt32
+    public int opt;
+}

Copied: 
gnunet-java/src/main/java/org/gnunet/mesh/messages/TunnelDestroyMessage.java 
(from rev 32831, 
gnunet-java/src/main/java/org/gnunet/mesh/TunnelDestroyMessage.java)
===================================================================
--- 
gnunet-java/src/main/java/org/gnunet/mesh/messages/TunnelDestroyMessage.java    
                            (rev 0)
+++ 
gnunet-java/src/main/java/org/gnunet/mesh/messages/TunnelDestroyMessage.java    
    2014-03-31 00:29:01 UTC (rev 32837)
@@ -0,0 +1,26 @@
+package org.gnunet.mesh.messages;
+
+import org.gnunet.construct.FixedSizeIntegerArray;
+import org.gnunet.construct.UInt32;
+import org.gnunet.construct.UnionCase;
+import org.gnunet.util.GnunetMessage;
+
+/**
+ * ...
+ *
+ * @author Florian Dold
+ */
address@hidden(274)
+public class TunnelDestroyMessage implements GnunetMessage.Body {
+    @UInt32
+    public long tunnelId;
+
+    @FixedSizeIntegerArray(bitSize = 8, signed = false, length = 32)
+    public byte[] reserved;
+
+    @UInt32
+    public int port;
+
+    @UInt32
+    public int opt;
+}

Modified: gnunet-java/src/main/resources/org/gnunet/construct/MsgMap.txt
===================================================================
--- gnunet-java/src/main/resources/org/gnunet/construct/MsgMap.txt      
2014-03-31 00:16:22 UTC (rev 32836)
+++ gnunet-java/src/main/resources/org/gnunet/construct/MsgMap.txt      
2014-03-31 00:29:01 UTC (rev 32837)
@@ -1,16 +1,16 @@
 org.gnunet.util.Resolver$Address|0=org.gnunet.util.Resolver$TextualAddress
 org.gnunet.util.Resolver$Address|1=org.gnunet.util.Resolver$NumericAddress
 org.gnunet.util.GnunetMessage$Body|1=org.gnunet.util.TestMessage
-org.gnunet.util.GnunetMessage$Body|274=org.gnunet.mesh.TunnelDestroyMessage
-org.gnunet.util.GnunetMessage$Body|273=org.gnunet.mesh.TunnelCreateMessage
-org.gnunet.util.GnunetMessage$Body|272=org.gnunet.mesh.ClientConnectMessage
+org.gnunet.util.GnunetMessage$Body|274=org.gnunet.mesh.messages.TunnelDestroyMessage
+org.gnunet.util.GnunetMessage$Body|273=org.gnunet.mesh.messages.TunnelCreateMessage
+org.gnunet.util.GnunetMessage$Body|272=org.gnunet.mesh.messages.ClientConnectMessage
 org.gnunet.util.GnunetMessage$Body|4=org.gnunet.util.Resolver$GetMessage
 org.gnunet.util.GnunetMessage$Body|5=org.gnunet.util.Resolver$ResolverResponse
 org.gnunet.util.GnunetMessage$Body|276=org.gnunet.mesh.RejectMessage
 org.gnunet.util.GnunetMessage$Body|10=org.gnunet.arm.messages.ResultMessage
 org.gnunet.util.GnunetMessage$Body|11=org.gnunet.arm.messages.StatusMessage
 org.gnunet.util.GnunetMessage$Body|13=org.gnunet.arm.messages.ListResultMessage
-org.gnunet.util.GnunetMessage$Body|286=org.gnunet.mesh.LocalAckMessage
+org.gnunet.util.GnunetMessage$Body|286=org.gnunet.mesh.messages.LocalAckMessage
 org.gnunet.util.GnunetMessage$Body|285=org.gnunet.mesh.DataMessage
 org.gnunet.util.GnunetMessage$Body|17=org.gnunet.hello.HelloMessage
 
org.gnunet.util.GnunetMessage$Body|42002=org.gnunet.voting.messages.BallotRegisterFailureMessage