Fix addjob documentation about timeout/TTL #21

mp911de · Jan 4, 2016 · cee5bdb · cee5bdb
1 parent e0932b8
commit cee5bdb
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 28 deletions.
diff --git a/src/main/java/biz/paluch/spinach/api/async/DisqueJobAsyncCommands.java b/src/main/java/biz/paluch/spinach/api/async/DisqueJobAsyncCommands.java
@@ -34,24 +34,24 @@ public interface DisqueJobAsyncCommands<K, V> {
      *
      * @param queue the queue name
      * @param job job body
-     * @param timeout TTL timeout
-     * @param timeUnit TTL timeout time unit
+     * @param commandTimeout command timeout to reach replication level
+     * @param timeUnit command timeout unit
      * @return the job id
      */
-    RedisFuture<String> addjob(K queue, V job, long timeout, TimeUnit timeUnit);
+    RedisFuture<String> addjob(K queue, V job, long commandTimeout, TimeUnit timeUnit);
 
     /**
      *
      * Add a job to the {@code queue} with the body {@code job}.
      *
      * @param queue the queue name
      * @param job job body
-     * @param timeout TTL timeout
-     * @param timeUnit TTL timeout time unit
+     * @param commandTimeout command timeout to reach replication level
+     * @param timeUnit command timeout unit
      * @param addJobArgs additional job arguments
      * @return the job id
      */
-    RedisFuture<String> addjob(K queue, V job, long timeout, TimeUnit timeUnit, AddJobArgs addJobArgs);
+    RedisFuture<String> addjob(K queue, V job, long commandTimeout, TimeUnit timeUnit, AddJobArgs addJobArgs);
 
     /**
      * Evict (and possibly remove from queue) all the jobs in memeory matching the specified job IDs. Jobs are evicted whatever

diff --git a/src/main/java/biz/paluch/spinach/api/rx/DisqueJobReactiveCommands.java b/src/main/java/biz/paluch/spinach/api/rx/DisqueJobReactiveCommands.java
@@ -34,24 +34,24 @@ public interface DisqueJobReactiveCommands<K, V> {
      *
      * @param queue the queue name
      * @param job job body
-     * @param timeout TTL timeout
-     * @param timeUnit TTL timeout time unit
+     * @param commandTimeout command timeout to reach replication level
+     * @param timeUnit command timeout unit
      * @return the job id
      */
-    Observable<String> addjob(K queue, V job, long timeout, TimeUnit timeUnit);
+    Observable<String> addjob(K queue, V job, long commandTimeout, TimeUnit timeUnit);
 
     /**
      *
      * Add a job to the {@code queue} with the body {@code job}.
      *
      * @param queue the queue name
      * @param job job body
-     * @param timeout TTL timeout
-     * @param timeUnit TTL timeout time unit
+     * @param commandTimeout command timeout to reach replication level
+     * @param timeUnit command timeout unit
      * @param addJobArgs additional job arguments
      * @return the job id
      */
-    Observable<String> addjob(K queue, V job, long timeout, TimeUnit timeUnit, AddJobArgs addJobArgs);
+    Observable<String> addjob(K queue, V job, long commandTimeout, TimeUnit timeUnit, AddJobArgs addJobArgs);
 
     /**
      * Evict (and possibly remove from queue) all the jobs in memeory matching the specified job IDs. Jobs are evicted whatever

diff --git a/src/main/java/biz/paluch/spinach/api/sync/DisqueJobCommands.java b/src/main/java/biz/paluch/spinach/api/sync/DisqueJobCommands.java
@@ -34,24 +34,24 @@ public interface DisqueJobCommands<K, V> {
      *
      * @param queue the queue name
      * @param job job body
-     * @param timeout TTL timeout
-     * @param timeUnit TTL timeout time unit
+     * @param commandTimeout command timeout for replication
+     * @param timeUnit command timeout unit
      * @return the job id
      */
-    String addjob(K queue, V job, long timeout, TimeUnit timeUnit);
+    String addjob(K queue, V job, long commandTimeout, TimeUnit timeUnit);
 
     /**
      *
      * Add a job to the {@code queue} with the body {@code job}.
      *
      * @param queue the queue name
      * @param job job body
-     * @param timeout TTL timeout
-     * @param timeUnit TTL timeout time unit
+     * @param commandTimeout command timeout to reach replication level
+     * @param timeUnit command timeout unit
      * @param addJobArgs additional job arguments
      * @return the job id
      */
-    String addjob(K queue, V job, long timeout, TimeUnit timeUnit, AddJobArgs addJobArgs);
+    String addjob(K queue, V job, long commandTimeout, TimeUnit timeUnit, AddJobArgs addJobArgs);
 
     /**
      * Evict (and possibly remove from queue) all the jobs in memeory matching the specified job IDs. Jobs are evicted whatever

diff --git a/src/main/java/biz/paluch/spinach/impl/DisqueAsyncCommandsImpl.java b/src/main/java/biz/paluch/spinach/impl/DisqueAsyncCommandsImpl.java
@@ -46,13 +46,13 @@ public RedisFuture<Long> ackjob(String... jobIds) {
     }
 
     @Override
-    public RedisFuture<String> addjob(K queue, V job, long duration, TimeUnit timeUnit) {
-        return dispatch(commandBuilder.addjob(queue, job, duration, timeUnit, null));
+    public RedisFuture<String> addjob(K queue, V job, long commandTimeout, TimeUnit timeUnit) {
+        return dispatch(commandBuilder.addjob(queue, job, commandTimeout, timeUnit, null));
     }
 
     @Override
-    public RedisFuture<String> addjob(K queue, V job, long duration, TimeUnit timeUnit, AddJobArgs addJobArgs) {
-        return dispatch(commandBuilder.addjob(queue, job, duration, timeUnit, addJobArgs));
+    public RedisFuture<String> addjob(K queue, V job, long commandTimeout, TimeUnit timeUnit, AddJobArgs addJobArgs) {
+        return dispatch(commandBuilder.addjob(queue, job, commandTimeout, timeUnit, addJobArgs));
     }
 
     @Override

diff --git a/src/main/java/biz/paluch/spinach/impl/DisqueCommandBuilder.java b/src/main/java/biz/paluch/spinach/impl/DisqueCommandBuilder.java
@@ -38,10 +38,10 @@ public Command<K, V, Long> ackjob(String[] jobIds) {
         return createCommand(ACKJOB, new IntegerOutput<K, V>(codec), args);
     }
 
-    public Command<K, V, String> addjob(K queue, V job, long duration, TimeUnit timeUnit, AddJobArgs addJobArgs) {
+    public Command<K, V, String> addjob(K queue, V job, long commandTimeout, TimeUnit timeUnit, AddJobArgs addJobArgs) {
         DisqueCommandArgs<K, V> args = new DisqueCommandArgs<K, V>(codec).addKey(queue).addValue(job);
         if (timeUnit != null) {
-            args.add(timeUnit.toMillis(duration));
+            args.add(timeUnit.toMillis(commandTimeout));
         } else {
             args.add(0);
         }

diff --git a/src/main/java/biz/paluch/spinach/impl/DisqueReactiveCommandsImpl.java b/src/main/java/biz/paluch/spinach/impl/DisqueReactiveCommandsImpl.java
@@ -49,13 +49,13 @@ public Observable<Long> ackjob(String... jobIds) {
     }
 
     @Override
-    public Observable<String> addjob(K queue, V job, long duration, TimeUnit timeUnit) {
-        return createObservable(commandBuilder.addjob(queue, job, duration, timeUnit, null));
+    public Observable<String> addjob(K queue, V job, long commandTimeout, TimeUnit timeUnit) {
+        return createObservable(commandBuilder.addjob(queue, job, commandTimeout, timeUnit, null));
     }
 
     @Override
-    public Observable<String> addjob(K queue, V job, long duration, TimeUnit timeUnit, AddJobArgs addJobArgs) {
-        return createObservable(commandBuilder.addjob(queue, job, duration, timeUnit, addJobArgs));
+    public Observable<String> addjob(K queue, V job, long commandTimeout, TimeUnit timeUnit, AddJobArgs addJobArgs) {
+        return createObservable(commandBuilder.addjob(queue, job, commandTimeout, timeUnit, addJobArgs));
     }
 
     @Override