This is an automated email from the ASF dual-hosted git repository.
tabish pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/qpid-protonj2.git
The following commit(s) were added to refs/heads/main by this push:
new 0a6af1c7 PROTON-2630 Javadoc updates for typos and missing details
0a6af1c7 is described below
commit 0a6af1c72a97c91fdae26a4211dfb1f07a5d0a3c
Author: Timothy Bish <[email protected]>
AuthorDate: Tue Oct 25 12:09:20 2022 -0400
PROTON-2630 Javadoc updates for typos and missing details
---
.../qpid/protonj2/client/ConnectionOptions.java | 10 +++++-----
.../org/apache/qpid/protonj2/client/LinkOptions.java | 3 ++-
.../java/org/apache/qpid/protonj2/client/Sender.java | 20 ++++++++++++++++++++
.../apache/qpid/protonj2/client/StreamSender.java | 20 ++++++++++++++++++++
4 files changed, 47 insertions(+), 6 deletions(-)
diff --git
a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/ConnectionOptions.java
b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/ConnectionOptions.java
index f369cb59..3f892028 100644
---
a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/ConnectionOptions.java
+++
b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/ConnectionOptions.java
@@ -580,12 +580,12 @@ public class ConnectionOptions implements Cloneable {
/**
* Controls if the connection will attempt to reconnect if unable to
connect immediately
- * or if an existing connection fails.
+ * or if an existing connection fails (default is disabled).
* <p>
- * This option enables or disables reconnection to a remote remote peer
after IO errors.
- * To control specifics of the reconnection configuration for the {@link
Connection} the
- * values must be updated in the {@link ReconnectOptions} configuration
prior to creating
- * the connection.
+ * This option enables or disables reconnection to a remote peer after IO
errors or remote
+ * forcibly closing the connection. To control specifics of the
reconnection configuration
+ * for the {@link Connection} the values must be updated in the {@link
ReconnectOptions}
+ * configuration prior to creating the connection.
*
* @param reconnectEnabled
* Controls if reconnection is enabled or not for the associated
{@link Connection}.
diff --git
a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/LinkOptions.java
b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/LinkOptions.java
index 8bbf61f2..a8e7e81a 100644
---
a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/LinkOptions.java
+++
b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/LinkOptions.java
@@ -66,7 +66,8 @@ public abstract class LinkOptions<T extends LinkOptions<T>> {
/**
* Controls if the created Link will automatically settle the deliveries
that have
- * been received by the application (default is <code>true</code>).
+ * been received by the application (default is <code>true</code>). This
option will
+ * also result in an accepted outcome being applied to the settled
delivery.
*
* @param autoSettle
* The value to assign for auto delivery settlement.
diff --git
a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/Sender.java
b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/Sender.java
index b22c6868..ddda0fcd 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/Sender.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/Sender.java
@@ -28,6 +28,11 @@ public interface Sender extends Link<Sender> {
/**
* Send the given message immediately if there is credit available or
blocks if the link
* has not yet been granted credit.
+ * <p>
+ * Upon successfully sending the message the methods returns a {@link
Tracker} that can
+ * be used to await settlement of the message from the remote. If the
sender has been
+ * configured to send the message pre-settled then the resulting Tracker
will immediately
+ * report the message as remotely settlement and accepted.
*
* @param message
* the {@link Message} to send.
@@ -43,6 +48,11 @@ public interface Sender extends Link<Sender> {
* has not yet been granted credit. The provided delivery annotations are
encoded along
* with the message, the annotations can be passed repeatedly to send
calls if sending
* the same delivery annotations with each message.
+ * <p>
+ * Upon successfully sending the message the methods returns a {@link
Tracker} that can
+ * be used to await settlement of the message from the remote. If the
sender has been
+ * configured to send the message pre-settled then the resulting Tracker
will immediately
+ * report the message as remotely settlement and accepted.
*
* @param message
* the {@link Message} to send.
@@ -58,6 +68,11 @@ public interface Sender extends Link<Sender> {
/**
* Send the given message if credit is available or returns null if no
credit has been
* granted to the link at the time of the send attempt.
+ * <p>
+ * Upon successfully sending the message the methods returns a {@link
Tracker} that can
+ * be used to await settlement of the message from the remote. If the
sender has been
+ * configured to send the message pre-settled then the resulting Tracker
will immediately
+ * report the message as remotely settlement and accepted.
*
* @param message
* the {@link Message} to send if credit is available.
@@ -73,6 +88,11 @@ public interface Sender extends Link<Sender> {
* granted to the link at the time of the send attempt. The provided
delivery annotations
* are encoded along with the message, the annotations can be passed
repeatedly to send
* calls if sending the same delivery annotations with each message.
+ * <p>
+ * Upon successfully sending the message the methods returns a {@link
Tracker} that can
+ * be used to await settlement of the message from the remote. If the
sender has been
+ * configured to send the message pre-settled then the resulting Tracker
will immediately
+ * report the message as remotely settlement and accepted.
*
* @param message
* the {@link Message} to send if credit is available.
diff --git
a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/StreamSender.java
b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/StreamSender.java
index 0e4f7339..01d27191 100644
---
a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/StreamSender.java
+++
b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/StreamSender.java
@@ -29,6 +29,11 @@ public interface StreamSender extends Link<StreamSender> {
/**
* Send the given message immediately if there is credit available or
blocks if the link
* has not yet been granted credit or there is a streaming send ongoing.
+ * <p>
+ * Upon successfully sending the message the methods returns a {@link
Tracker} that can
+ * be used to await settlement of the message from the remote. If the
sender has been
+ * configured to send the message pre-settled then the resulting Tracker
will immediately
+ * report the message as remotely settlement and accepted.
*
* @param message
* the {@link Message} to send.
@@ -44,6 +49,11 @@ public interface StreamSender extends Link<StreamSender> {
* has not yet been granted credit or there is a streaming send ongoing.
The provided
* delivery annotations are encoded along with the message, the
annotations can be passed
* repeatedly to send calls if sending the same delivery annotations with
each message.
+ * <p>
+ * Upon successfully sending the message the methods returns a {@link
Tracker} that can
+ * be used to await settlement of the message from the remote. If the
sender has been
+ * configured to send the message pre-settled then the resulting Tracker
will immediately
+ * report the message as remotely settlement and accepted.
*
* @param message
* the {@link Message} to send.
@@ -59,6 +69,11 @@ public interface StreamSender extends Link<StreamSender> {
/**
* Send the given message if credit is available or returns null if no
credit has been
* granted to the link at the time of the send attempt or a streaming send
is ongoing.
+ * <p>
+ * Upon successfully sending the message the methods returns a {@link
Tracker} that can
+ * be used to await settlement of the message from the remote. If the
sender has been
+ * configured to send the message pre-settled then the resulting Tracker
will immediately
+ * report the message as remotely settlement and accepted.
*
* @param message
* the {@link Message} to send if credit is available.
@@ -74,6 +89,11 @@ public interface StreamSender extends Link<StreamSender> {
* granted to the link at the time of the send attempt. The provided
delivery annotations
* are encoded along with the message, the annotations can be passed
repeatedly to send
* calls if sending the same delivery annotations with each message.
+ * <p>
+ * Upon successfully sending the message the methods returns a {@link
Tracker} that can
+ * be used to await settlement of the message from the remote. If the
sender has been
+ * configured to send the message pre-settled then the resulting Tracker
will immediately
+ * report the message as remotely settlement and accepted.
*
* @param message
* the {@link Message} to send if credit is available.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
