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 2122893 Add sections in the configuration document for stream sender
/ receiver
2122893 is described below
commit 2122893c24a09c26b3f1b307c8b1ca4a876e2824
Author: Timothy Bish <tabish...@gmail.com>
AuthorDate: Wed Apr 21 14:48:28 2021 -0400
Add sections in the configuration document for stream sender / receiver
---
protonj2-client-docs/Configuration.md | 33 +++++++++++++++++++++++++++++++--
1 file changed, 31 insertions(+), 2 deletions(-)
diff --git a/protonj2-client-docs/Configuration.md
b/protonj2-client-docs/Configuration.md
index edc45fb..509b057 100644
--- a/protonj2-client-docs/Configuration.md
+++ b/protonj2-client-docs/Configuration.md
@@ -1,4 +1,4 @@
-# Qpid protonj2 Imperative Client configuration
+# Qpid ProtonJ2 Imperative Client configuration
This file details various configuration options for the Imperative API based
Java client. Each of the resources
that allow configuration accept a configuration options object that
encapsulates all configuration for that specific
@@ -153,7 +153,7 @@ When creating a new Receiver the **ReceiverOptions** object
can be provided whic
ReceiverOptions receiverOptions = new ReceiverOptions();
Receiver receiver = session.openReceiver("address", receiverOptions);
-The following options are available for configuration when creating a new
**Sender**.
+The following options are available for configuration when creating a new
**Receiver**.
+ **ReceiverOptions.creditWindow** Configures the size of the credit window
the Receiver will open with the remote which the Receiver will replenish
automatically as incoming deliveries are read. The default value is 10, to
disable and control credit manually this value should be set to zero.
+ **ReceiverOptions.closeTimeout** Timeout value that controls how long the
client session waits on resource closure before returning. By default the
client uses the matching session level close timeout option value.
@@ -161,6 +161,35 @@ The following options are available for configuration when
creating a new **Send
+ **ReceiverOptions.requestTimeout** Timeout value that controls how long the
client Receiver waits on completion of various synchronous interactions, such
settlement of a delivery, before returning an error. By default the client uses
the matching session level request timeout option value.
+ **ReceiverOptions.drainTimeout** Timeout value that controls how long the
Receiver link waits on completion of a drain request before failing that
request with an error. By default the client uses the matching session level
drain timeout option value.
+## Stream Sender Configuration Options
+
+When creating a new Sender the **SenderOptions** object can be provided which
allows some control over various behaviors of the sender.
+
+ StreamSenderOptions streamSenderOptions = new StreamSenderOptions();
+ StreamSender streamSender = connection.openStreamSender("address",
streamSenderOptions);
+
+The following options are available for configuration when creating a new
**StreamSender**.
+
++ **StreamSenderOptions.closeTimeout** Timeout value that controls how long
the client Sender waits on resource closure before returning. By default the
client uses the matching session level close timeout option value.
++ **StreamSenderOptions.sendTimeout** Timeout value that sets the Sender
default send timeout which can control how long a Sender waits on completion of
a synchronous message send before returning an error. By default the client
uses the matching session level send timeout option value.
++ **StreamSenderOptions.openTimeout** Timeout value that controls how long the
client Sender waits on the AMQP Open process to complete before returning with
an error. By default the client uses the matching session level close timeout
option value.
++ **StreamSenderOptions.requestTimeout** Timeout value that controls how long
the client connection waits on completion of various synchronous interactions,
such as initiating or retiring a transaction, before returning an error. Does
not affect synchronous message sends. By default the client uses the matching
session level request timeout option value.
+
+## Stream Receiver Configuration Options
+
+When creating a new Receiver the **ReceiverOptions** object can be provided
which allows some control over various behaviors of the receiver.
+
+ StreamReceiverOptions streamReceiverOptions = new StreamReceiverOptions();
+ StreamReceiver streamReceiver = connection.openStreamReceiver("address",
streamReceiverOptions);
+
+The following options are available for configuration when creating a new
**StreamReceiver**.
+
++ **StreamReceiverOptions.creditWindow** Configures the size of the credit
window the Receiver will open with the remote which the Receiver will replenish
automatically as incoming deliveries are read. The default value is 10, to
disable and control credit manually this value should be set to zero.
++ **StreamReceiverOptions.closeTimeout** Timeout value that controls how long
the client session waits on resource closure before returning. By default the
client uses the matching session level close timeout option value.
++ **StreamReceiverOptions.openTimeout** Timeout value that controls how long
the client Session waits on the AMQP Open process to complete before returning
with an error. By default the client uses the matching session level close
timeout option value.
++ **StreamReceiverOptions.requestTimeout** Timeout value that controls how
long the client Receiver waits on completion of various synchronous
interactions, such settlement of a delivery, before returning an error. By
default the client uses the matching session level request timeout option value.
++ **StreamReceiverOptions.drainTimeout** Timeout value that controls how long
the Receiver link waits on completion of a drain request before failing that
request with an error. By default the client uses the matching session level
drain timeout option value.
+
## Logging
The client makes use of the SLF4J API, allowing users to select a particular
logging implementation based on their needs by supplying a SLF4J 'binding',
such as *slf4j-log4j* in order to use Log4J. More details on SLF4J are
available from http://www.slf4j.org/.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@qpid.apache.org
For additional commands, e-mail: commits-h...@qpid.apache.org
