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

Timestamp:

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

Author:

stoda

Message:

J

File:

• trunk/src/main/java/omq/common/message/Response.java (modified) (2 diffs)

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;