Merge default into bug16247

Author: Hubert Plociniczak

.hgignore

@@ -0,0 +1,5 @@
+syntax: glob
+*~
+
+syntax: regexp
+^build/

src/com/rabbitmq/client/AlreadyClosedException.java

@@ -1,19 +1,12 @@
 package com.rabbitmq.client;
 
-public class AlreadyClosedException extends IllegalStateException {
-	
-	public AlreadyClosedException()
+/*
+ * Thrown when application tries to perform an action on connection/channel
+ * which was already closed
+ */
+public class AlreadyClosedException extends ShutdownSignalException {
+	public AlreadyClosedException(String s, Object ref)
 	{
-		super();
-	}
-	
-	public AlreadyClosedException(Throwable e)
-	{
-		super(e);
-	}
-
-	public AlreadyClosedException(String s)
-	{
-		super(s);
+		super(true, true, s, ref);
 	}
 }

src/com/rabbitmq/client/Channel.java

@@ -56,7 +56,7 @@
  * 
  */
 
-public interface Channel {
+public interface Channel extends ShutdownNotifier{
     /**
      * Retrieve this channel's channel number.
      * @return the channel number
@@ -433,38 +433,4 @@ Queue.DeclareOk queueDeclare(int ticket, String queue, boolean passive, boolean
      * @throws java.io.IOException if an error is encountered
      */
     Tx.RollbackOk txRollback() throws IOException;
-
-    /**
-     * Add shutdown listener to the channel
-     * 
-     * @param listener {@link ShutdownListener} for the channel
-     */
-    void addShutdownListener(ShutdownListener listener);
-    
-    /**
-     * Remove shutdown listener for the channel.
-     * 
-     * @param listener {@link ShutdownListener} to be removed
-     */
-    void removeShutdownListener(ShutdownListener listener);
-    
-    /**
-     * Get connection channel shutdown reason.
-     * Return null if channel is still open.
-     * @see com.rabbitmq.client.ShutdownCause 
-     * @return shutdown reason if channel is closed
-     */
-    ShutdownSignalException getCloseReason();
-    
-    /**
-     * Determine if channel is currently open.
-     * Will return false if we are currently closing or closed.
-     * Checking this method should be only for information,
-     * because of the race conditions - state can change after the call.
-     * Instead just execute and and try to catch AlreadyClosedException
-     * 
-     * @see com.rabbitmq.client.impl.AMQChannel#isOpen()
-     * @return true when channel is open, false otherwise
-     */
-    boolean isOpen();
 }

src/com/rabbitmq/client/Connection.java

@@ -49,7 +49,7 @@
  * Current implementations are thread-safe for code at the client API level,
  * and in fact thread-safe internally except for code within RPC calls.
  */
-public interface Connection { // rename to AMQPConnection later, this is a temporary name
+public interface Connection extends ShutdownNotifier { // rename to AMQPConnection later, this is a temporary name
     /**
      * Retrieve the host.
      * @return the hostname of the peer we're connected to.
@@ -127,39 +127,4 @@ public interface Connection { // rename to AMQPConnection later, this is a tempo
      * @throws IOException if an I/O problem is encountered
      */
     void close(int closeCode, String closeMessage) throws IOException;
-    
-    /**
-     * Add connection shutdown listener.
-     * If the connection is already closed handler is fired immediately
-     * 
-     * @param listener {@link ShutdownListener} to the connection
-     */
-    void addShutdownListener(ShutdownListener listener);
-    
-    /**
-     * Remove shutdown listener for the connection.
-     * 
-     * @param listener {@link ShutdownListener} to be removed
-     */
-    void removeShutdownListener(ShutdownListener listener);
-    
-    /**
-     * Retrieve connection close reason.
-     * 
-     * @see com.rabbitmq.client.ShutdownCause
-     * @return information about the cause of closing the connection, or null if connection is still open
-     */
-    ShutdownSignalException getCloseReason();
-    
-    /**
-     * Determine whether the connection is currently open.
-     * Will return false if we are currently closing.
-     * Checking this method should be only for information,
-     * because of the race conditions - state can change after the call.
-     * Instead just execute and and try to catch AlreadyClosedException
-     * 
-     * @see com.rabbitmq.client.impl.AMQConnection#isOpen()
-     * @return true when connection is open, false otherwise
-     */
-    boolean isOpen();
 }

src/com/rabbitmq/client/ShutdownListener.java

@@ -4,6 +4,6 @@
 
 public interface ShutdownListener extends EventListener {
 
-	public void service(ShutdownSignalException cause);
+	public void shutdownCompleted(ShutdownSignalException cause);
 
 }

src/com/rabbitmq/client/ShutdownNotifier.java

@@ -0,0 +1,49 @@
+package com.rabbitmq.client;
+
+/**
+ * Interface for components that are shutdown capable and
+ * that allow listeners to be added for shutdown signals
+ * 
+ * @see ShutdownListener
+ * @see ShutdownSignalException
+ */
+public interface ShutdownNotifier {
+    /**
+     * Add shutdown listener.
+     * If the component is already closed, handler is fired immediately
+     * 
+     * @param listener {@link ShutdownListener} to the component
+     */
+    public void addShutdownListener(ShutdownListener listener);
+    
+    /**
+     * Remove shutdown listener for the component.
+     * 
+     * @param listener {@link ShutdownListener} to be removed
+     */
+    public void removeShutdownListener(ShutdownListener listener);
+    
+    /**
+     * Get the shutdown reason object
+     * @return ShutdownSignalException if component is closed, null otherwise
+     */
+    public ShutdownSignalException getCloseReason();
+    
+    /**
+     * Protected API - notify the listeners attached to the component
+     * @see com.rabbitmq.client.ShutdownListener
+     */
+    public void notifyListeners();
+    
+    /**
+     * Determine whether the component is currently open.
+     * Will return false if we are currently closing.
+     * Checking this method should be only for information,
+     * because of the race conditions - state can change after the call.
+     * Instead just execute and try to catch ShutdownSignalException
+     * and IOException
+     * 
+     * @return true when component is open, false otherwise
+     */
+    boolean isOpen();
+}

src/com/rabbitmq/client/ShutdownSignalException.java

@@ -32,7 +32,7 @@
  * this exception.
  */
 
-public class ShutdownSignalException extends Exception {
+public class ShutdownSignalException extends RuntimeException {
     /** True if the connection is shut down, or false if this signal refers to a channel */
     private final boolean _hardError;
 

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

@@ -30,7 +30,6 @@
 import com.rabbitmq.client.AlreadyClosedException;
 import com.rabbitmq.client.Command;
 import com.rabbitmq.client.Connection;
-import com.rabbitmq.client.ShutdownListener;
 import com.rabbitmq.client.ShutdownSignalException;
 import com.rabbitmq.utility.BlockingValueOrException;
 import com.rabbitmq.utility.SingleShotLinearTimer;
@@ -43,7 +42,7 @@
  * @see ChannelN
  * @see Connection
  */
-public abstract class AMQChannel {
+public abstract class AMQChannel extends ShutdownNotifierComponent {
     /** The connection this channel is associated with. */
     public final AMQConnection _connection;
 
@@ -55,9 +54,6 @@ public abstract class AMQChannel {
 
     /** The current outstanding RPC request, if any. (Could become a queue in future.) */
     public RpcContinuation _activeRpc = null;
-    
-    /** Reason for closing the channel, null if still open */
-    public volatile ShutdownSignalException _cause;
 
     /**
      * Construct a channel on the given connection, with the given channel number.
@@ -119,6 +115,10 @@ public AMQCommand exnWrappingRpc(Method m)
     {
         try {
             return rpc(m);
+        } catch (AlreadyClosedException ace) {
+        	// Do not wrap it since it means that connection/channel
+        	// was closed in some action in the past
+        	throw ace;
         } catch (ShutdownSignalException ex) {
             throw wrap(ex);
         }
@@ -169,29 +169,11 @@ public synchronized RpcContinuation nextOutstandingRpc()
         return result;
     }
 
-    /**
-     * Public API - Indicates whether this channel is in an open state
-     * @return true if channel is open, false otherwise
-     */
-    public boolean isOpen()
-    {
-        return _cause == null;
-    }
-    
-    /**
-     * Public API - Get the reason for closing the channel 
-     * @return object having information about the shutdown, or null if still open
-     */
-    public ShutdownSignalException getCloseReason() 
-    {
-    	return _cause;
-    }
-
     public void ensureIsOpen()
         throws AlreadyClosedException
     {
         if (!isOpen()) {
-            throw new AlreadyClosedException("Attempt to use closed channel");
+            throw new AlreadyClosedException("Attempt to use closed channel", this);
         }
     }
 
@@ -278,7 +260,7 @@ public void run() {
     public void processShutdownSignal(ShutdownSignalException signal) {
         synchronized (this) {
             ensureIsOpen(); // invariant: we should never be shut down more than once per instance
-            _cause = signal;
+            _shutdownCause = signal;
         }
         RpcContinuation k = nextOutstandingRpc();
         if (k != null) {