merger

Author: tonyg

src/com/rabbitmq/client/Connection.java

@@ -75,12 +75,13 @@ public interface Connection extends ShutdownNotifier { // rename to AMQPConnecti
     ConnectionParameters getParameters();
 
     /**
-     * Get the negotiated maximum number of channels allowed.
+     * Get the negotiated maximum channel number. Usable channel
+     * numbers range from 1 to this number, inclusive.
      *
      * Note that this is the <i>current</i> setting, as opposed to the <i>initially-requested</i>
      * setting available from {@link #getParameters()}.{@link ConnectionParameters#getRequestedChannelMax()}.
      *
-     * @return the maximum number of simultaneously-open channels permitted for this connection.
+     * @return the maximum channel number permitted for this connection.
      */
     int getChannelMax();
 

src/com/rabbitmq/client/ConnectionParameters.java

@@ -54,7 +54,7 @@ private static String safeGetProperty(String key, String def) {
     /** Default virtual host */
     public static final String DEFAULT_VHOST = "/";
 
-    /** Default value for the desired maximum number of channels; zero for
+    /** Default value for the desired maximum channel number; zero for
      * unlimited */
     public static final int DEFAULT_CHANNEL_MAX = 0;
 
@@ -126,8 +126,8 @@ public void setVirtualHost(String virtualHost) {
     }
 
     /**
-     * Retrieve the requested maximum number of channels
-     * @return the initially requested maximum number of channels; zero for unlimited
+     * Retrieve the requested maximum channel number
+     * @return the initially requested maximum channel number; zero for unlimited
      */
     public int getRequestedChannelMax() {
         return _requestedChannelMax;
@@ -166,8 +166,8 @@ public void setRequestedHeartbeat(int requestedHeartbeat) {
     }
 
     /**
-     * Set the requested maximum number of channels
-     * @param requestedChannelMax initially requested maximum number of channels; zero for unlimited
+     * Set the requested maximum channel number
+     * @param requestedChannelMax initially requested maximum channel number; zero for unlimited
      */
     public void setRequestedChannelMax(int requestedChannelMax) {
         _requestedChannelMax = requestedChannelMax;

src/com/rabbitmq/client/GetResponse.java

@@ -47,7 +47,7 @@ public class GetResponse {
      * @param envelope the {@link Envelope}
      * @param props message properties
      * @param body the message body
-     * @param messageCount the number of messages in the response
+     * @param messageCount the server's most recent estimate of the number of messages remaining on the queue
      */
     public GetResponse(Envelope envelope, BasicProperties props, byte[] body, int messageCount)
     {
@@ -82,8 +82,20 @@ public byte[] getBody() {
     }
 
     /**
-     * Get the message count included in this response
-     * @return the message count
+     * Get the server's most recent estimate of the number of messages
+     * remaining on the queue. This number can only ever be a rough
+     * estimate, because of concurrent activity at the server and the
+     * delay between the server sending its estimate and the client
+     * receiving and processing the message containing the estimate.
+     *
+     * <p>According to the AMQP specification, this figure does not
+     * include the message being delivered. For example, this field
+     * will be zero in the simplest case of a single reader issuing a
+     * Basic.Get on a private queue holding a single message (the
+     * message being delivered in this GetResponse).
+     *
+     * @return an estimate of the number of messages remaining to be
+     * read from the queue
      */
     public int getMessageCount() {
         return messageCount;

src/com/rabbitmq/client/ShutdownSignalException.java

@@ -66,6 +66,10 @@ public ShutdownSignalException(boolean hardError,
                                    boolean initiatedByApplication,
                                    Object reason, Object ref)
     {
+        super((initiatedByApplication
+               ? ("clean " + (hardError ? "connection" : "channel") + " shutdown")
+               : ((hardError ? "connection" : "channel") + " error"))
+              + "; reason: " + reason);
         this._hardError = hardError;
         this._initiatedByApplication = initiatedByApplication;
         this._reason = reason;
@@ -88,13 +92,6 @@ public ShutdownSignalException(boolean hardError,
     /** @return Reference to Connection or Channel object that fired the signal **/
     public Object getReference() { return _ref; }
 
-    public String toString() {
-        return super.toString() + " (" +
-            (_initiatedByApplication
-                    ? ("clean " + (_hardError ? "connection" : "channel") + " shutdown")
-             : ((_hardError ? "connection" : "channel") + " error"))
-            + "; reason: " + _reason + ")";
-    }
 }
 
 

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

@@ -100,17 +100,17 @@ public AMQCommand(Method method, AMQContentHeader contentHeader, byte[] body) {
         setContentBody(body);
     }
 
-    /** Public API - Retrieve the Command's method. */
+    /** Public API - {@inheritDoc} */
     public Method getMethod() {
         return _method;
     }
 
-    /** Public API - Retrieve the Command's ContentHeader. */
+    /** Public API - {@inheritDoc} */
     public ContentHeader getContentHeader() {
         return _contentHeader;
     }
 
-    /** Public API - Retrieve the Command's content body. */
+    /** Public API - {@inheritDoc} */
     public byte[] getContentBody() {
         if (_bodyN != null) {
             coalesceContentBody();

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

@@ -144,18 +144,22 @@ public void ensureIsOpen()
     /** Hosts retrieved from the connection.open-ok */
     public Address[] _knownHosts;
 
+    /** {@inheritDoc} */
     public String getHost() {
         return _frameHandler.getHost();
     }
 
+    /** {@inheritDoc} */
     public int getPort() {
         return _frameHandler.getPort();
     }
 
+    /** {@inheritDoc} */
     public ConnectionParameters getParameters() {
         return _params;
     }
 
+    /** {@inheritDoc} */
     public Address[] getKnownHosts() {
         return _knownHosts;
     }
@@ -211,23 +215,19 @@ public void checkPreconditions() {
         AMQCommand.checkEmptyContentBodyFrameSize();
     }
 
-    /**
-     * @see com.rabbitmq.client.Connection#getChannelMax()
-     */
+    /** {@inheritDoc} */
     public int getChannelMax() {
         return _channelManager.getChannelMax();
     }
 
     /**
-     * Protected API - set the max <b>number</b> of channels available
+     * Protected API - set the max channel <b>number</b>
      */
     public void setChannelMax(int value) {
         _channelManager.setChannelMax(value);
     }
 
-    /**
-     * @see com.rabbitmq.client.Connection#getFrameMax()
-     */
+    /** {@inheritDoc} */
     public int getFrameMax() {
         return _frameMax;
     }
@@ -240,9 +240,7 @@ public void setFrameMax(int value) {
         _frameMax = value;
     }
 
-    /**
-     * @see com.rabbitmq.client.Connection#getHeartbeat()
-     */
+    /** {@inheritDoc} */
     public int getHeartbeat() {
         return _heartbeat;
     }
@@ -270,18 +268,13 @@ public ExceptionHandler getExceptionHandler() {
         return _exceptionHandler;
     }
 
-    /**
-     * Public API - creates a new channel using the specified channel number.
-     */
-
+    /** Public API - {@inheritDoc} */
     public Channel createChannel(int channelNumber) throws IOException {
         ensureIsOpen();
         return _channelManager.createChannel(this, channelNumber);
     }
 
-    /**
-     * Public API - creates a new channel using an internally allocated channel number.
-     */
+    /** Public API - {@inheritDoc} */
     public Channel createChannel() throws IOException {
         ensureIsOpen();
         return _channelManager.createChannel(this);
@@ -617,45 +610,53 @@ public ShutdownSignalException shutdown(Object reason,
         return sse;
     }
 
+    /** Public API - {@inheritDoc} */
     public void close()
         throws IOException
     {
         close(-1);
     }
 
+    /** Public API - {@inheritDoc} */
     public void close(int timeout)
         throws IOException
     {
         close(AMQP.REPLY_SUCCESS, "OK", timeout);
     }
 
+    /** Public API - {@inheritDoc} */
     public void close(int closeCode, String closeMessage)
         throws IOException
     {
         close(closeCode, closeMessage, -1);
     }
 
+    /** Public API - {@inheritDoc} */
     public void close(int closeCode, String closeMessage, int timeout)
         throws IOException
     {
         close(closeCode, closeMessage, true, null, timeout, false);
     }
 
+    /** Public API - {@inheritDoc} */
     public void abort()
     {
         abort(-1);
     }
 
+    /** Public API - {@inheritDoc} */
     public void abort(int closeCode, String closeMessage)
     {
        abort(closeCode, closeMessage, -1);
     }
 
+    /** Public API - {@inheritDoc} */
     public void abort(int timeout)
     {
         abort(AMQP.REPLY_SUCCESS, "OK", timeout);
     }
 
+    /** Public API - {@inheritDoc} */
     public void abort(int closeCode, String closeMessage, int timeout)
     {
         try {
@@ -664,7 +665,13 @@ public void abort(int closeCode, String closeMessage, int timeout)
             Utility.emptyStatement();
         }
     }
-    
+
+    /** 
+     * Protected API - Delegates to {@link
+     * #close(int,String,boolean,Throwable,int,boolean) the
+     * six-argument close method}, passing 0 for the timeout, and
+     * false for the abort flag.
+     */
     public void close(int closeCode,
                       String closeMessage,
                       boolean initiatedByApplication,

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

@@ -63,7 +63,7 @@ public void writeTo(DataOutputStream out, long bodySize) throws IOException {
     }
 
     /**
-     *  Private API - Autogenerated reader for this header
+     * Private API - Autogenerated reader for this header
      */
     public abstract void readPropertiesFrom(ContentHeaderPropertyReader reader) throws IOException;
 
@@ -72,9 +72,7 @@ public void writeTo(DataOutputStream out, long bodySize) throws IOException {
      */
     public abstract void writePropertiesTo(ContentHeaderPropertyWriter writer) throws IOException;
 
-    /**
-     * Public API - Debugging hook
-     */
+    /** Public API - {@inheritDoc} */
     public void appendPropertyDebugStringTo(StringBuffer acc) {
         acc.append("(?)");
     }

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

@@ -47,7 +47,7 @@ public class ChannelManager {
     /** Mapping from channel number to AMQChannel instance */
     private final Map<Integer, ChannelN> _channelMap = Collections.synchronizedMap(new HashMap<Integer, ChannelN>());
 
-    /** Maximum number of channels available on this connection. */
+    /** Maximum channel number available on this connection. */
     public int _channelMax = 0;
 
     public synchronized int getChannelMax() {
@@ -101,7 +101,7 @@ public synchronized int allocateChannelNumber(int maxChannels) {
             maxChannels = Integer.MAX_VALUE;
         }
         int channelNumber = -1;
-        for (int candidate = 1; candidate < maxChannels; candidate++) {
+        for (int candidate = 1; candidate <= maxChannels; candidate++) {
             if (!_channelMap.containsKey(candidate)) {
                 channelNumber = candidate;
                 break;