Change the name and JavaDoc for the noAck parameter in many methods in the channel API. This doesn't affect auto-generated code;

 I'm making this a difference between the protocol and our interface to it.

Author: Michael Bridgen

src/com/rabbitmq/client/Channel.java

@@ -185,8 +185,7 @@ public interface Channel extends ShutdownNotifier {
      * Request specific "quality of service" settings.
      *
      * These settings impose limits on the amount of data the server
-     * will deliver to consumers before requiring the receipt of
-     * acknowledgements.
+     * will deliver to consumers before requiring acknowledgements.
      * Thus they provide a means of consumer-initiated flow control.
      * @see com.rabbitmq.client.AMQP.Basic.Qos
      * @param prefetchSize maximum amount of content (measured in
@@ -428,11 +427,13 @@ Queue.DeclareOk queueDeclare(String queue, boolean durable, boolean exclusive, b
      * @see com.rabbitmq.client.AMQP.Basic.GetOk
      * @see com.rabbitmq.client.AMQP.Basic.GetEmpty
      * @param queue the name of the queue
-     * @param noAck true if no handshake is required
+     * @param autoAck true if the server should consider messages
+     * acknowledged once delivered; false if the server should expect
+     * explicit acknowledgements
      * @return a {@link GetResponse} containing the retrieved message data
      * @throws java.io.IOException if an error is encountered
      */
-    GetResponse basicGet(String queue, boolean noAck) throws IOException;
+    GetResponse basicGet(String queue, boolean autoAck) throws IOException;
 
     /**
      * Acknowledge one or several received
@@ -441,7 +442,9 @@ Queue.DeclareOk queueDeclare(String queue, boolean durable, boolean exclusive, b
      * containing the received message being acknowledged.
      * @see com.rabbitmq.client.AMQP.Basic.Ack
      * @param deliveryTag the tag from the received {@link com.rabbitmq.client.AMQP.Basic.GetOk} or {@link com.rabbitmq.client.AMQP.Basic.Deliver}
-     * @param multiple true if we are acknowledging multiple messages with the same delivery tag
+     * @param multiple true to acknowledge all messages up to and
+     * including the supplied delivery tag; false to acknowledge just
+     * the supplied delivery tag.
      * @throws java.io.IOException if an error is encountered
      */
     void basicAck(long deliveryTag, boolean multiple) throws IOException;
@@ -459,7 +462,7 @@ Queue.DeclareOk queueDeclare(String queue, boolean durable, boolean exclusive, b
 
     /**
      * Start a non-nolocal, non-exclusive consumer, with
-     * explicit acknowledgements required and a server-generated consumerTag.
+     * explicit acknowledgement and a server-generated consumerTag.
      * @param queue the name of the queue
      * @param callback an interface to the consumer object
      * @return the consumerTag generated by the server
@@ -475,20 +478,24 @@ Queue.DeclareOk queueDeclare(String queue, boolean durable, boolean exclusive, b
      * Start a non-nolocal, non-exclusive consumer, with
      * a server-generated consumerTag.
      * @param queue the name of the queue
-     * @param noAck true if no handshake is required
+     * @param autoAck true if the server should consider messages
+     * acknowledged once delivered; false if the server should expect
+     * explicit acknowledgements
      * @param callback an interface to the consumer object
      * @return the consumerTag generated by the server
      * @throws java.io.IOException if an error is encountered
      * @see com.rabbitmq.client.AMQP.Basic.Consume
      * @see com.rabbitmq.client.AMQP.Basic.ConsumeOk
      * @see #basicConsume(String,boolean, String,boolean,boolean, Map, Consumer)
      */
-    String basicConsume(String queue, boolean noAck, Consumer callback) throws IOException;
+    String basicConsume(String queue, boolean autoAck, Consumer callback) throws IOException;
 
     /**
      * Start a non-nolocal, non-exclusive consumer.
      * @param queue the name of the queue
-     * @param noAck true if no handshake is required
+     * @param autoAck true if the server should consider messages
+     * acknowledged once delivered; false if the server should expect
+     * explicit acknowledgements
      * @param consumerTag a client-generated consumer tag to establish context
      * @param callback an interface to the consumer object
      * @return the consumerTag associated with the new consumer
@@ -497,13 +504,15 @@ Queue.DeclareOk queueDeclare(String queue, boolean durable, boolean exclusive, b
      * @see com.rabbitmq.client.AMQP.Basic.ConsumeOk
      * @see #basicConsume(String,boolean, String,boolean,boolean, Map, Consumer)
      */
-    String basicConsume(String queue, boolean noAck, String consumerTag, Consumer callback) throws IOException;
+    String basicConsume(String queue, boolean autoAck, String consumerTag, Consumer callback) throws IOException;
 
     /**
      * Start a consumer. Calls the consumer's {@link Consumer#handleConsumeOk}
      * method before returning.
      * @param queue the name of the queue
-     * @param noAck true if no handshake is required
+     * @param autoAck true if the server should consider messages
+     * acknowledged once delivered; false if the server should expect
+     * explicit acknowledgements
      * @param consumerTag a client-generated consumer tag to establish context
      * @param noLocal flag set to true unless server local buffering is required
      * @param exclusive true if this is an exclusive consumer
@@ -514,7 +523,7 @@ Queue.DeclareOk queueDeclare(String queue, boolean durable, boolean exclusive, b
      * @see com.rabbitmq.client.AMQP.Basic.Consume
      * @see com.rabbitmq.client.AMQP.Basic.ConsumeOk
      */
-    String basicConsume(String queue, boolean noAck, String consumerTag, boolean noLocal, boolean exclusive, Map<String, Object> arguments, Consumer callback) throws IOException;
+    String basicConsume(String queue, boolean autoAck, String consumerTag, boolean noLocal, boolean exclusive, Map<String, Object> arguments, Consumer callback) throws IOException;
 
     /**
      * Cancel a consumer. Calls the consumer's {@link Consumer#handleCancelOk}

src/com/rabbitmq/client/impl/ChannelN.java

@@ -609,10 +609,10 @@ public Queue.UnbindOk queueUnbind(String queue, String exchange, String routingK
     }
 
     /** Public API - {@inheritDoc} */
-    public GetResponse basicGet(String queue, boolean noAck)
+    public GetResponse basicGet(String queue, boolean autoAck)
         throws IOException
     {
-        AMQCommand replyCommand = exnWrappingRpc(new Basic.Get(TICKET, queue, noAck));
+        AMQCommand replyCommand = exnWrappingRpc(new Basic.Get(TICKET, queue, autoAck));
         Method method = replyCommand.getMethod();
 
         if (method instanceof Basic.GetOk) {
@@ -654,22 +654,22 @@ public String basicConsume(String queue, Consumer callback)
     }
 
     /** Public API - {@inheritDoc} */
-    public String basicConsume(String queue, boolean noAck, Consumer callback)
+    public String basicConsume(String queue, boolean autoAck, Consumer callback)
         throws IOException
     {
-        return basicConsume(queue, noAck, "", callback);
+        return basicConsume(queue, autoAck, "", callback);
     }
 
     /** Public API - {@inheritDoc} */
-    public String basicConsume(String queue, boolean noAck, String consumerTag,
+    public String basicConsume(String queue, boolean autoAck, String consumerTag,
                                Consumer callback)
         throws IOException
     {
-        return basicConsume(queue, noAck, consumerTag, false, false, null, callback);
+        return basicConsume(queue, autoAck, consumerTag, false, false, null, callback);
     }
 
     /** Public API - {@inheritDoc} */
-    public String basicConsume(String queue, boolean noAck, String consumerTag,
+    public String basicConsume(String queue, boolean autoAck, String consumerTag,
                                boolean noLocal, boolean exclusive, Map<String, Object> arguments,
                                final Consumer callback)
         throws IOException
@@ -694,7 +694,7 @@ public String transformReply(AMQCommand replyCommand) {
         };
 
         rpc(new Basic.Consume(TICKET, queue, consumerTag,
-                              noLocal, noAck, exclusive,
+                              noLocal, autoAck, exclusive,
                               false, arguments),
             k);