Changeset 83 for trunk/src/main/java/omq/common/message

Timestamp:

07/08/13 13:29:24 (11 years ago)

Author:

stoda

Message:

J

Location:

trunk/src/main/java/omq/common/message

Files:

• Request.java (modified) (4 diffs)
• Response.java (modified) (2 diffs)

trunk/src/main/java/omq/common/message/Request.java

@@ -3 +3 @@
 import java.io.Serializable;
 
+/**
+ * Serializable request information. This class is used to send the information
+ * to the server. It has information about which method is wanted to invoke, its
+ * parameters, its correlation id and if a response is needed -asynchronous
+ * method-.
+ * 
+ * @author Sergi Toda <sergi.toda@estudiants.urv.cat>
+ * 
+ */
 public class Request implements Serializable {
 
@@ -20 +29 @@
         private transient int retries;
 
+        // This constructor is used by kryo
         public Request() {
         }
@@ -38 +48 @@
         }
 
+        /**
+         * This method creates a new synchronous request
+         * 
+         * @param id
+         *            - correlation id of this invocation
+         * @param method
+         *            - method name wanted to call
+         * @param params
+         *            - parameters of this method
+         * @return - new SyncRequest
+         */
         public static Request newSyncRequest(String id, String method, Object[] params) {
                 return new Request(id, method, false, params);
         }
 
+        /**
+         * This method creates a new synchronous request
+         * 
+         * @param id
+         *            - correlation id of this invocation
+         * @param method
+         *            - method name wanted to call
+         * @param params
+         *            - parameters of this method
+         * @param retries
+         *            - How many retries will be done
+         * @param timeout
+         *            - Timeout for every retry
+         * @param multi
+         *            - If the method is multi
+         * @param wait
+         *            - If the method is multi how many responses will be listened
+         * @return - new SyncRequest
+         */
         public static Request newSyncRequest(String id, String method, Object[] params, int retries, long timeout, boolean multi, int wait) {
                 Request req = new Request(id, method, false, params, multi);
@@ -50 +90 @@
         }
 
+        /**
+         * This method creates a new asynchronous request
+         * 
+         * @param id
+         *            - correlation id of this invocation
+         * @param method
+         *            - method name wanted to call
+         * @param params
+         *            - parameters of this method
+         * @param multi
+         *            - If the method is multi
+         * @return new AsyncRequest
+         */
         public static Request newAsyncRequest(String id, String method, Object[] params, boolean multi) {
                 return new Request(id, method, true, params, multi);

trunk/src/main/java/omq/common/message/Response.java

@@ -5 +5 @@
 import omq.exception.OmqException;
 
+/**
+ * Serializable response information. This class is used to send the information
+ * to the client proxy. It has information about which remoteObject has invoked
+ * the method and its correlation id. This class also has the result of the
+ * invoke if everything has gone fine in the server or an error otherwise.
+ * 
+ * @author Sergi Toda <sergi.toda@estudiants.urv.cat>
+ * 
+ */
 public class Response implements Serializable {
 
@@ -17 +26 @@
         private String idOmq;
 
+        // Used by kryo
         public Response() {
         }
 
+        /**
+         * Creates a new Response object to be serialized
+         * 
+         * @param id
+         *            - correlation id of the invoke
+         * @param idOmq
+         *            - objectmq's identifier -bind reference-
+         * @param result
+         *            - result of the invocation
+         * @param error
+         *            - error thrown by the invocation
+         */
         public Response(String id, String idOmq, Object result, OmqException error) {
                 this.id = id;