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
commit f3e11c9b841e542b3582dec80ca0eb97c9a85317 Author: Timothy Bish <tabish...@gmail.com> AuthorDate: Wed Jun 16 17:35:30 2021 -0400 PROTON-2394 Fix some typos in the existing client docs --- .../org/apache/qpid/protonj2/client/Connection.java | 21 +++++++++++++++++---- .../org/apache/qpid/protonj2/client/Message.java | 1 + .../apache/qpid/protonj2/client/SessionOptions.java | 8 ++++---- .../org/apache/qpid/protonj2/client/Source.java | 2 +- 4 files changed, 23 insertions(+), 9 deletions(-) diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/Connection.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/Connection.java index c129982..c8ffe35 100644 --- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/Connection.java +++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/Connection.java @@ -122,7 +122,14 @@ public interface Connection extends AutoCloseable { /** * Creates a receiver used to consume messages from the given node address and configure it - * such that the remote create a durable node. + * such that the remote create a durable node. The returned receiver will be configured using + * default options and will take its timeout configuration values from those specified in the + * parent {@link Connection}. + * + * The returned receiver may not have been opened on the remote when it is returned. Some methods of the + * {@link Receiver} can block until the remote fully opens the receiver, the user can wait for the remote + * to respond to the open request by calling the {@link Receiver#openFuture()} method and using the + * {@link Future#get()} methods to wait for completion. * * @param address * The source address to attach the consumer to. @@ -137,7 +144,13 @@ public interface Connection extends AutoCloseable { /** * Creates a receiver used to consume messages from the given node address and configure it - * such that the remote create a durable node. + * such that the remote create a durable node. The returned receiver will be configured using + * provided options. + * + * The returned receiver may not have been opened on the remote when it is returned. Some methods of the + * {@link Receiver} can block until the remote fully opens the receiver, the user can wait for the remote + * to respond to the open request by calling the {@link Receiver#openFuture()} method and using the + * {@link Future#get()} methods to wait for completion. * * @param address * The source address to attach the consumer to. @@ -169,7 +182,7 @@ public interface Connection extends AutoCloseable { Receiver openDynamicReceiver() throws ClientException; /** - * Creates a dynamic receiver used to consume messages from the given node address. + * Creates a dynamic receiver used to consume messages from a dynamically generated node on the remote.. * * The returned receiver may not have been opened on the remote when it is returned. Some methods of the * {@link Receiver} can block until the remote fully opens the receiver, the user can wait for the remote @@ -186,7 +199,7 @@ public interface Connection extends AutoCloseable { Receiver openDynamicReceiver(Map<String, Object> dynamicNodeProperties) throws ClientException; /** - * Creates a dynamic receiver used to consume messages from the given node address. + * Creates a dynamic receiver used to consume messages from a dynamically generated node on the remote.. * * The returned receiver may not have been opened on the remote when it is returned. Some methods of the * {@link Receiver} can block until the remote fully opens the receiver, the user can wait for the remote diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/Message.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/Message.java index c0f7b22..1d97a60 100644 --- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/Message.java +++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/Message.java @@ -167,6 +167,7 @@ public interface Message<E> { /** * Sets the relative message priority. Higher numbers indicate higher priority messages. * Messages with higher priorities MAY be delivered before those with lower priorities. + * For a received message this overwrites any value that was set by the remote sender. * * @param priority * The priority value to assign this message. diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/SessionOptions.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/SessionOptions.java index f13176c..a61221c 100644 --- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/SessionOptions.java +++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/SessionOptions.java @@ -355,8 +355,8 @@ public class SessionOptions { } /** - * Sets the incoming capacity for a {@link Session} the created session. The incoming capacity - * control how much buffering a session will allow before applying back pressure to the remote + * Sets the incoming capacity for a {@link Session} created with these options. The incoming capacity + * controls how much buffering a session will allow before applying back pressure to the remote * thereby preventing excessive memory overhead. * <p> * This is an advanced option and in most cases the client defaults should be left in place unless @@ -380,8 +380,8 @@ public class SessionOptions { } /** - * Sets the outgoing capacity for a {@link Session} the created session. The outgoing capacity - * control how much buffering a session will allow before applying back pressure to the local + * Sets the outgoing capacity for a {@link Session} created with these options. The outgoing capacity + * controls how much buffering a session will allow before applying back pressure to the local * thereby preventing excessive memory overhead while writing large amounts of data and the * client is experiencing back-pressure due to the remote not keeping pace. * <p> diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/Source.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/Source.java index f99e0d0..fca0b60 100644 --- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/Source.java +++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/Source.java @@ -48,7 +48,7 @@ public interface Source { ExpiryPolicy expiryPolicy(); /** - * @return true if the Source node dynamically on-demand + * @return true if the Source node was created dynamically on-demand */ boolean dynamic(); --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@qpid.apache.org For additional commands, e-mail: commits-h...@qpid.apache.org