Changeset 82 for trunk/src/main/java/omq/client

Timestamp:

07/05/13 16:51:11 (11 years ago)

Author:

stoda

Message:

I've done some javadocs...

Location:

trunk/src/main/java/omq/client

Files:

• annotation/MultiMethod.java (modified) (1 diff)
• annotation/RemoteInterface.java (modified) (1 diff)
• annotation/SyncMethod.java (modified) (1 diff)
• listener/RequestInfo.java (deleted)
• listener/ResponseListener.java (modified) (4 diffs)
• proxy/Proxymq.java (modified) (6 diffs)

trunk/src/main/java/omq/client/annotation/MultiMethod.java

@@ -9 +9 @@
 @Target(ElementType.METHOD)
 public @interface MultiMethod {
+        /**
+         * If @MultiMethod is followed by @SyncMethod waitNum indicates how many
+         * responses we will wait for.
+         * 
+         * @return length of the array of responses we are waiting for.
+         */
         int waitNum() default 1;
 }

trunk/src/main/java/omq/client/annotation/RemoteInterface.java

@@ -10 +10 @@
  * Annotation which indicates which is the remote interface that can have
  * asynchmethods or syncmethods. By default every method without an annotation
- * will be classified as a SyncMethod
+ * will be classified as a SyncMethod. Both annotations can be preceded by the @MultiMethod
+ * annotation.
  * 
  * @author Sergi Toda <sergi.toda@estudiants.urv.cat>

trunk/src/main/java/omq/client/annotation/SyncMethod.java

@@ -17 +17 @@
 @Target(ElementType.METHOD)
 public @interface SyncMethod {
+        /**
+         * Timeout of a synchronous method
+         * 
+         * @return how long we'll wait for a response
+         */
         long timeout() default 60000L;
 
+        /**
+         * Number of retries of a synchronous method
+         * 
+         * @return how many retries we'll make. If the timeout is set, every timeout
+         *         will use it
+         */
         int retry() default 1;
 }

trunk/src/main/java/omq/client/listener/ResponseListener.java

@@ -21 +21 @@
 
 /**
- * Class that inherits from RemoteListener. It's used in the server side. This
- * class gets the deliveries from the server and stores them into the proxies
+ * Class that inherits from Thread. It's used in the client side. This class
+ * gets the deliveries from the server and stores them into the different
+ * proxies created.
  * 
  * @author Sergi Toda <sergi.toda@estudiants.urv.cat>
@@ -38 +39 @@
 
         /**
-         * Protected constructor used by the singleton pattern
+         * ResponseListener constructor
          * 
-         * @param env
+         * @param broker
          * @throws Exception
          */
@@ -108 +109 @@
         }
 
+        /**
+         * This function is used to start the response client queue
+         * 
+         * @throws Exception
+         */
         private void startRPCQueue() throws Exception {
                 channel = broker.getNewChannel();
@@ -151 +157 @@
         }
 
-        // Revisar això
+        /**
+         * This method registers a new proxy into this responseListener
+         * 
+         * @param proxy
+         */
         public void registerProxy(Proxymq proxy) {
+                // Since results is a hashtable this method doesn't need to be
+                // synchronized
                 if (!results.containsKey(proxy.getRef())) {
                         results.put(proxy.getRef(), proxy.getResults());

trunk/src/main/java/omq/client/proxy/Proxymq.java

@@ -27 +27 @@
 
 /**
- * EvoProxy class. This class inherits from InvocationHandler and gives you a
- * proxy with a server using an environment
+ * Proxymq class. This class inherits from InvocationHandler, for this reason
+ * each proxymq instance has an associated invocation handler. When a method is
+ * invoked on a proxymq instance, the method invocation is encoded and
+ * dispatched to the invoke method of its invocation handler.
  * 
  * @author Sergi Toda <sergi.toda@estudiants.urv.cat>
@@ -66 +68 @@
 
         /**
-         * EvoProxy Constructor.
+         * Proxymq Constructor.
          * 
          * This constructor uses an uid to know which object will call. It also uses
@@ -131 +133 @@
         }
 
+        /**
+         * This method publishes a request
+         * 
+         * @param request
+         *            - this request contains which method and which params will be
+         *            invoked in the server side.
+         * @param replyQueueName
+         *            - this param indicates where the responseListener will be
+         *            listen to.
+         * @throws Exception
+         */
         private void publishMessage(Request request, String replyQueueName) throws Exception {
                 String corrId = request.getId();
@@ -158 +171 @@
         }
 
+        /**
+         * This method publishes a synchronous request
+         * 
+         * @param request
+         *            - this request contains which method and which params will be
+         *            invoked in the server side.
+         * @param type
+         *            - indicates which return type we are waiting for
+         * @return serverResponse
+         * @throws Exception
+         */
         private Object publishSyncRequest(Request request, Class<?> type) throws Exception {
                 String corrId = request.getId();
@@ -170 +194 @@
                                 publishMessage(request, replyQueueName);
                                 if (request.isMulti()) {
-                                        return getResults(corrId, 2, timeout, type);
+                                        return getResults(corrId, request.getWait(), timeout, type);
                                 } else {
                                         return getResult(corrId, timeout, type);
@@ -183 +207 @@
         }
 
+        /**
+         * This method creates a request using the annotations of the Remote
+         * interface
+         * 
+         * @param method
+         *            - method to invoke in the server side
+         * @param arguments
+         *            - arguments of the method
+         * @return new Request
+         */
         private Request createRequest(Method method, Object[] arguments) {
                 String corrId = java.util.UUID.randomUUID().toString();