Author: jstrachan
Date: Thu Jun 8 08:37:36 2006
New Revision: 412781
URL: http://svn.apache.org/viewvc?rev=412781&view=rev
Log:
updated javadoc comments
Modified:
incubator/activemq/trunk/activemq-core/src/main/java/org/apache/activemq/ActiveMQConnection.java
Modified:
incubator/activemq/trunk/activemq-core/src/main/java/org/apache/activemq/ActiveMQConnection.java
URL:
http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-core/src/main/java/org/apache/activemq/ActiveMQConnection.java?rev=412781&r1=412780&r2=412781&view=diff
==============================================================================
---
incubator/activemq/trunk/activemq-core/src/main/java/org/apache/activemq/ActiveMQConnection.java
(original)
+++
incubator/activemq/trunk/activemq-core/src/main/java/org/apache/activemq/ActiveMQConnection.java
Thu Jun 8 08:37:36 2006
@@ -759,6 +759,7 @@
}
/**
+ * Sets whether or not timestamps on messages should be disabled or not.
If you disable them it adds a small performance boost.
*
* @param timeStampsDisableByDefault
* The timeStampsDisableByDefault to set.
@@ -793,7 +794,13 @@
/**
- * @param closeTimeout The closeTimeout to set.
+ * Sets the timeout before a close is considered complete. Normally a
+ * close() on a connection waits for confirmation from the broker; this
+ * allows that operation to timeout to save the client hanging if there is
+ * no broker
+ *
+ * @param closeTimeout
+ * The closeTimeout to set.
*/
public void setCloseTimeout(int closeTimeout){
this.closeTimeout=closeTimeout;
@@ -1372,6 +1379,8 @@
/**
+ * Enables an optimised acknowledgement mode where messages are
acknowledged in batches rather than individually
+ *
* @param optimizeAcknowledge The optimizeAcknowledge to set.
*/
public void setOptimizeAcknowledge(boolean optimizeAcknowledge){
@@ -1577,6 +1586,11 @@
return useCompression;
}
+ /**
+ * Enables the use of compression of the message bodies
+ *
+ * @param useCompression
+ */
public void setUseCompression(boolean useCompression) {
this.useCompression = useCompression;
}
@@ -1803,6 +1817,14 @@
}
}
+ /**
+ * Should a JMS message be copied to a new JMS Message object as part of
the
+ * send() method in JMS. This is enabled by default to be compliant with
the
+ * JMS specification. You can disable it if you do not mutate JMS messages
+ * after they are sent for a performance boost
+ *
+ * @param copyMessageOnSend
+ */
public void setCopyMessageOnSend(boolean copyMessageOnSend) {
this.copyMessageOnSend = copyMessageOnSend;
}
