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

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/annotation

Files:

• MultiMethod.java (modified) (1 diff)
• RemoteInterface.java (modified) (1 diff)
• SyncMethod.java (modified) (1 diff)

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;
 }