Changeset 82 for trunk/src/main/java/omq/client/proxy/Proxymq.java

Timestamp:

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

Author:

stoda

Message:

I've done some javadocs...

File:

• trunk/src/main/java/omq/client/proxy/Proxymq.java (modified) (6 diffs)

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();