merge bug19470 into default

Author: Matthias Radestock

src/com/rabbitmq/client/Channel.java

@@ -70,9 +70,18 @@ public interface Channel extends ShutdownNotifier{
     Connection getConnection();
 
     /**
-     * Close this channel with the given code and message
+     * Close this channel with the {@link com.rabbitmq.client.AMQP#REPLY_SUCCESS} close code
+     * and message 'OK'.
+     * 
+     * @throws java.io.IOException if an error is encountered
+     */
+    void close() throws IOException;
+    
+    /**
+     * Close this channel.
+     * 
      * @param closeCode the close code (See under "Reply Codes" in the AMQP specification)
-     * @param closeMessage a message indicating the reason for closing the channel
+     * @param closeMessage a message indicating the reason for closing the connection
      * @throws java.io.IOException if an error is encountered
      */
     void close(int closeCode, String closeMessage) throws IOException;

src/com/rabbitmq/client/Connection.java

@@ -121,44 +121,103 @@ public interface Connection extends ShutdownNotifier { // rename to AMQPConnecti
     Channel createChannel(int channelNumber) throws IOException;
 
     /**
-     * Close this connection and all its channels.
+     * Close this connection and all its channels
+     * with the {@link com.rabbitmq.client.AMQP#REPLY_SUCCESS} close code
+     * and message 'OK'.
      *
-     * This method will wait infinitely for all the close operations to
-     * complete.
+     * Waits for all the close operations to complete.
      *
      * @throws IOException if an I/O problem is encountered
      */
     void close() throws IOException;
+    
+    /**
+     * Close this connection and all its channels.
+     *
+     * Waits for all the close operations to complete.
+     *
+     * @param closeCode the close code (See under "Reply Codes" in the AMQP specification)
+     * @param closeMessage a message indicating the reason for closing the connection
+     * @throws IOException if an I/O problem is encountered
+     */
+    void close(int closeCode, String closeMessage) throws IOException;
 
     /**
      * Close this connection and all its channels
-     *
-     * This method will wait with the given timeout for all the close
-     * operations to complete. If timeout is reached then socket is forced
-     * to close
-     * @param timeout timeout (in milioseconds) for completing all the close-related
+     * with the {@link com.rabbitmq.client.AMQP#REPLY_SUCCESS} close code
+     * and message 'OK'.
+     * 
+     * This method behaves in a similar way as {@link #close()}, with the only difference
+     * that it waits with a provided timeout for all the close operations to
+     * complete. When timeout is reached the socket is forced to close.
+     * 
+     * @param timeout timeout (in milliseconds) for completing all the close-related
      * operations, use -1 for infinity
      * @throws IOException if an I/O problem is encountered
      */
     void close(int timeout) throws IOException;
+    
+    /**
+     * Close this connection and all its channels.
+     *
+     * Waits with the given timeout for all the close operations to complete.
+     * When timeout is reached the socket is forced to close.
+     * 
+     * @param closeCode the close code (See under "Reply Codes" in the AMQP specification)
+     * @param closeMessage a message indicating the reason for closing the connection
+     * @param timeout timeout (in milliseconds) for completing all the close-related
+     * operations, use -1 for infinity
+     * @throws IOException if an I/O problem is encountered
+     */
+    void close(int closeCode, String closeMessage, int timeout) throws IOException;
 
     /**
-     * Abort this connection and all its channels.
+     * Abort this connection and all its channels
+     * with the {@link com.rabbitmq.client.AMQP#REPLY_SUCCESS} close code
+     * and message 'OK'.
      *
-     * This method will force the connection to close. It will silently discard
-     * any exceptions enountered in close operations
+     * Forces the connection to close.
+     * Any encountered exceptions in the close operations are silently discarded.
      */
     void abort();
-
+    
     /**
      * Abort this connection and all its channels.
      *
-     * This method behaves in a similar way as abort(), with the only difference
-     * that it will wait with a provided timeout for all the close operations to
-     * complete. If timeout is reached socket is forced to close.
+     * Forces the connection to close and waits for all the close operations to complete.
+     * Any encountered exceptions in the close operations are silently discarded.
+     * 
+     * @param closeCode the close code (See under "Reply Codes" in the AMQP specification)
+     * @param closeMessage a message indicating the reason for closing the connection
+     */
+    void abort(int closeCode, String closeMessage);
+    
+    /**
+     * Abort this connection and all its channels
+     * with the {@link com.rabbitmq.client.AMQP#REPLY_SUCCESS} close code
+     * and message 'OK'.
+     *
+     * This method behaves in a similar way as {@link #abort()}, with the only difference
+     * that it waits with a provided timeout for all the close operations to
+     * complete. When timeout is reached the socket is forced to close.
      *
-     * @param timeout timeout (in miliseconds) for completing all the close-related
+     * @param timeout timeout (in milliseconds) for completing all the close-related
      * operations, use -1 for infinity
      */
     void abort(int timeout);
+
+    /**
+     * Abort this connection and all its channels.
+     *
+     * Forces the connection to close and waits with the given timeout
+     * for all the close operations to complete. When timeout is reached
+     * the socket is forced to close.
+     * Any encountered exceptions in the close operations are silently discarded.
+     *
+     * @param closeCode the close code (See under "Reply Codes" in the AMQP specification)
+     * @param closeMessage a message indicating the reason for closing the connection
+     * @param timeout timeout (in milliseconds) for completing all the close-related
+     * operations, use -1 for infinity
+     */
+    void abort(int closeCode, String closeMessage, int timeout);
 }

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

@@ -62,7 +62,7 @@
  * int ticket = ch1.accessRequest(realmName);
  * </pre>
  */
-public class AMQConnection extends ShutdownNotifierComponent implements Connection{
+public class AMQConnection extends ShutdownNotifierComponent implements Connection {
     /** Timeout used while waiting for AMQP handshaking to complete (milliseconds) */
     public static final int HANDSHAKE_TIMEOUT = 10000;
 
@@ -617,59 +617,54 @@ public void shutdown(Object reason,
         _channelManager.handleSignal(_shutdownCause);
     }
 
-    /**
-     * Public API - Close this connection and all its channels
-     */
     public void close()
         throws IOException
     {
         close(-1);
     }
 
-    /**
-     * Public API - Close this connection and all its channels
-     * with a given timeout
-     */
     public void close(int timeout)
         throws IOException
     {
-        close(200, "Goodbye", timeout);
+        close(AMQP.REPLY_SUCCESS, "OK", timeout);
     }
 
-    /**
-     * Public API - Abort this connection and all its channels
-     */
-    public void abort()
+    public void close(int closeCode, String closeMessage)
+        throws IOException
     {
-        abort(-1);
+        close(closeCode, closeMessage, -1);
     }
 
-    public void abort(int timeout)
+    public void close(int closeCode, String closeMessage, int timeout)
+        throws IOException
     {
+        close(closeCode, closeMessage, true, null, timeout, false);
+    }
 
-        try {
-            close(200, "Goodbye", true, null, timeout, true);
-        } catch (IOException e) {
-            Utility.emptyStatement();
-        }
+    public void abort()
+    {
+        abort(-1);
     }
 
-    /**
-     * Protected API - Close this connection with the given code and message.
-     * See the comments in ChannelN.close() - we're very similar.
-     */
-    public void close(int closeCode, String closeMessage)
-        throws IOException
+    public void abort(int closeCode, String closeMessage)
     {
-        close(closeCode, closeMessage, 0);
+       abort(closeCode, closeMessage, -1);
     }
 
-    public void close(int closeCode, String closeMessage, int timeout)
-        throws IOException
+    public void abort(int timeout)
     {
-        close(closeCode, closeMessage, true, null, timeout, false);
+        abort(AMQP.REPLY_SUCCESS, "OK", timeout);
     }
 
+    public void abort(int closeCode, String closeMessage, int timeout)
+    {
+        try {
+            close(closeCode, closeMessage, true, null, timeout, true);
+        } catch (IOException e) {
+            Utility.emptyStatement();
+        }
+    }
+    
     public void close(int closeCode,
                       String closeMessage,
                       boolean initiatedByApplication,
@@ -680,7 +675,9 @@ public void close(int closeCode,
     }
 
     /**
-     * Protected API - Close this connection with the given code, message and source.
+     * Protected API - Close this connection with the given code, message, source
+     * and timeout value for all the close operations to complete.
+     * Specifies if any encountered exceptions should be ignored.
      */
     public void close(int closeCode,
                       String closeMessage,

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

@@ -31,6 +31,7 @@
 import java.util.Map;
 import java.util.concurrent.TimeoutException;
 
+import com.rabbitmq.client.AMQP;
 import com.rabbitmq.client.Command;
 import com.rabbitmq.client.Connection;
 import com.rabbitmq.client.Consumer;
@@ -248,19 +249,22 @@ public void releaseChannelNumber() {
         }
     }
 
-    /**
-     * Public API - closes this channel with the given code and message
-     */
+    public void close()
+        throws IOException
+    {
+        close(AMQP.REPLY_SUCCESS, "OK");
+    }
+    
     public void close(int closeCode, String closeMessage)
         throws IOException
     {
         close(closeCode, closeMessage, true, null);
     }
 
     /**
-     * Protected API - close channel with code and message, indicating
+     * Protected API - Close channel with code and message, indicating
      * the source of the closure and a causing exception (null if
-     * none)
+     * none).
      */
     public void close(int closeCode,
                       String closeMessage,

test/src/com/rabbitmq/client/test/Bug19219Test.java

@@ -28,17 +28,14 @@
 import java.util.concurrent.CountDownLatch;
 import java.util.concurrent.Semaphore;
 
-import junit.framework.TestCase;
 import junit.framework.TestSuite;
 
-import com.rabbitmq.client.AMQP;
 import com.rabbitmq.client.Channel;
 import com.rabbitmq.client.Connection;
 import com.rabbitmq.client.Consumer;
 import com.rabbitmq.client.DefaultConsumer;
 import com.rabbitmq.client.MessageProperties;
 import com.rabbitmq.client.ShutdownSignalException;
-
 import com.rabbitmq.client.test.functional.BrokerTestCase;
 
 /**
@@ -136,7 +133,7 @@ public void run() {
         //notifications timing out.
         boolean success = false;
         try {
-            channel.close(AMQP.REPLY_SUCCESS, "bye");
+            channel.close();
             success = true;
         } catch (ShutdownSignalException e) {
         } finally {

test/src/com/rabbitmq/client/test/functional/BrokerTestCase.java

@@ -69,7 +69,7 @@ public void closeChannel()
         throws IOException
     {
         if (channel != null) {
-            channel.close(200, "OK");
+            channel.close();
             channel = null;
         }
     }

test/src/com/rabbitmq/client/test/functional/PersisterRestart1.java

@@ -50,7 +50,7 @@ protected void tearDown()
         throws IOException
     {
         if (channel2 != null) {
-            channel2.close(200, "OK");
+            channel2.close();
             channel2 = null;
         }
         super.tearDown();

test/src/com/rabbitmq/examples/ConsumerMain.java

@@ -126,7 +126,7 @@ private void runIt() throws IOException {
         channel.queueDelete(ticket, completionQueue);
 
         System.out.println("Closing the channel.");
-        channel.close(200, "Closing channel with no error");
+        channel.close();
 
         System.out.println("Closing the connection.");
         _connection.close();

test/src/com/rabbitmq/examples/ProducerMain.java

@@ -163,7 +163,7 @@ private void runIt() throws IOException {
                 _channel.txCommit();
         }
 
-        _channel.close(200, "Closing ch1 with no error");
+        _channel.close();
         System.out.println("Closing.");
         _connection.close();
         System.out.println("Leaving ProducerMain.run().");

test/src/com/rabbitmq/examples/SendString.java

@@ -51,7 +51,7 @@ public static void main(String[] args) {
 
             ch.exchangeDeclare(ticket, exchange, exchangeType);
             ch.basicPublish(ticket, exchange, routingKey, null, message.getBytes());
-            ch.close(200, "Closing the channel");
+            ch.close();
             conn.close();
         } catch (Exception e) {
             System.err.println("Main thread caught exception: " + e);