Added documentation.

redis · Jun 8, 2014 · 02e384c · 02e384c
1 parent 590a133
commit 02e384c
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/lettuce/src/main/java/com/lambdaworks/redis/RedisFuture.java b/lettuce/src/main/java/com/lambdaworks/redis/RedisFuture.java
@@ -20,5 +20,13 @@ public interface RedisFuture<V> extends ListenableFuture<V> {
      */
     String getError();
 
+    /**
+     * Wait up to the specified time for the command output to become available.
+     *
+     * @param timeout Maximum time to wait for a result.
+     * @param unit Unit of time for the timeout.
+     *
+     * @return true if the output became available.
+     */
     boolean await(long timeout, TimeUnit unit);
 }