This is an automated email from the ASF dual-hosted git repository.
kpvdr pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/qpid-proton.git
The following commit(s) were added to refs/heads/main by this push:
new 8e4d08e PROTON-2060: Proposed doc changes to clarify auto-settle usage
8e4d08e is described below
commit 8e4d08e5b17ae1bd6c022f735d842f4fdf84ffac
Author: Kim van der Riet <[email protected]>
AuthorDate: Wed Feb 23 12:51:14 2022 -0500
PROTON-2060: Proposed doc changes to clarify auto-settle usage
---
cpp/include/proton/sender_options.hpp | 5 ++++-
python/proton/_handlers.py | 13 ++++++++-----
ruby/lib/core/sender.rb | 6 +++---
3 files changed, 15 insertions(+), 9 deletions(-)
diff --git a/cpp/include/proton/sender_options.hpp
b/cpp/include/proton/sender_options.hpp
index a706806..60aac55 100644
--- a/cpp/include/proton/sender_options.hpp
+++ b/cpp/include/proton/sender_options.hpp
@@ -82,7 +82,10 @@ class sender_options {
/// Set the delivery mode on the sender.
PN_CPP_EXTERN sender_options& delivery_mode(delivery_mode);
- /// Automatically settle messages (default is true).
+ /**
+ * If ``True`` (default), automatically settle messages upon receiving a
settled
+ * disposition for that delivery. Otherwise messages must be explicitly
settled.
+ */
PN_CPP_EXTERN sender_options& auto_settle(bool);
/// Options for the source node of the sender.
diff --git a/python/proton/_handlers.py b/python/proton/_handlers.py
index 1a7849c..ac783d0 100644
--- a/python/proton/_handlers.py
+++ b/python/proton/_handlers.py
@@ -48,7 +48,8 @@ class OutgoingMessageHandler(Handler):
A utility for simpler and more intuitive handling of delivery
events related to outgoing i.e. sent messages.
- :param auto_settle: If ``True``, settle all messages (default). Otherwise
+ :param auto_settle: If ``True`` (default), automatically settle messages
+ upon receiving a settled disposition for that delivery. Otherwise
messages must be explicitly settled.
:type auto_settle: ``bool``
:param delegate: A client handler for the endpoint event
@@ -666,7 +667,8 @@ class MessagingHandler(Handler, Acking):
:param prefetch: Initial flow credit for receiving messages, defaults to
10.
:param auto_accept: If ``True``, accept all messages (default). Otherwise
messages must be individually accepted or rejected.
- :param auto_settle: If ``True``, settle all messages (default). Otherwise
+ :param auto_settle: If ``True`` (default), automatically settle messages
+ upon receiving a settled disposition for that delivery. Otherwise
messages must be explicitly settled.
:param peer_close_is_error: If ``True``, a peer endpoint closing will be
treated as an error with an error callback. Otherwise (default), the
@@ -951,9 +953,10 @@ class TransactionalClientHandler(MessagingHandler,
TransactionHandler):
a transactional acceptance of received messages.
:param prefetch: Initial flow credit for receiving messages, defaults to
10.
- :param auto_accept: If ``True``, accept all messages (default). Otherwise
messages
- must be individually accepted or rejected.
- :param auto_settle: If ``True``, settle all messages (default). Otherwise
+ :param auto_accept: If ``True``, accept all messages (default). Otherwise
+ messages must be individually accepted or rejected.
+ :param auto_settle: If ``True`` (default), automatically settle messages
+ upon receiving a settled disposition for that delivery. Otherwise
messages must be explicitly settled.
:param peer_close_is_error: If ``True``, a peer endpoint closing will be
treated as an error with an error callback. Otherwise (default), the
diff --git a/ruby/lib/core/sender.rb b/ruby/lib/core/sender.rb
index ff035cb..3769751 100644
--- a/ruby/lib/core/sender.rb
+++ b/ruby/lib/core/sender.rb
@@ -32,7 +32,9 @@ module Qpid::Proton
# @overload open_sender(address)
# @param address [String] address of the target to send to
# @overload open_sender(opts)
- # @option opts [Boolean] :auto_settle (true) if true, automatically
settle transfers
+ # @option opts [Boolean] :auto_settle (true) If true (default),
automatically settle
+ # messages upon receiving a settled disposition for that delivery.
Otherwise messages
+ # must be explicitly settled.
# @option opts [Boolean] :dynamic (false) dynamic property for source
{Terminus#dynamic}
# @option opts [String,Hash] :source source address or source options,
see {Terminus#apply}
# @option opts [String,Hash] :target target address or target options,
see {Terminus#apply}
@@ -95,5 +97,3 @@ module Qpid::Proton
can_raise_error :stream, :error_class => Qpid::Proton::LinkError
end
end
-
-
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
