You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by ac...@apache.org on 2018/03/15 23:08:57 UTC
[3/3] qpid-proton git commit: NO-JIRA: [ruby] Minor API doc and
comment fixes.
NO-JIRA: [ruby] Minor API doc and comment fixes.
Project: http://git-wip-us.apache.org/repos/asf/qpid-proton/repo
Commit: http://git-wip-us.apache.org/repos/asf/qpid-proton/commit/26138b75
Tree: http://git-wip-us.apache.org/repos/asf/qpid-proton/tree/26138b75
Diff: http://git-wip-us.apache.org/repos/asf/qpid-proton/diff/26138b75
Branch: refs/heads/master
Commit: 26138b75df3fef8b666c48e4e88c17ecc2eaf084
Parents: 9ca7f40
Author: Alan Conway <ac...@redhat.com>
Authored: Wed Mar 14 11:27:33 2018 -0400
Committer: Alan Conway <ac...@redhat.com>
Committed: Thu Mar 15 19:08:27 2018 -0400
----------------------------------------------------------------------
proton-c/bindings/ruby/lib/core/connection.rb | 5 ++---
proton-c/bindings/ruby/lib/core/messaging_handler.rb | 3 ++-
proton-c/bindings/ruby/lib/core/receiver.rb | 3 +--
3 files changed, 5 insertions(+), 6 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/26138b75/proton-c/bindings/ruby/lib/core/connection.rb
----------------------------------------------------------------------
diff --git a/proton-c/bindings/ruby/lib/core/connection.rb b/proton-c/bindings/ruby/lib/core/connection.rb
index 8adc259..327be10 100644
--- a/proton-c/bindings/ruby/lib/core/connection.rb
+++ b/proton-c/bindings/ruby/lib/core/connection.rb
@@ -124,9 +124,8 @@ module Qpid::Proton
# @private
def apply opts
- # NOTE: Only connection options are set here. Transport options are set
- # with {Transport#apply} from the connection_driver (or in
- # on_connection_bound if not using a connection_driver)
+ # NOTE: Only connection options are set here.
+ # Transport options must be applied with {Transport#apply}
@container = opts[:container]
cid = opts[:container_id] || (@container && @container.id) || SecureRandom.uuid
cid = cid.to_s if cid.is_a? Symbol # Allow symbols as container name
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/26138b75/proton-c/bindings/ruby/lib/core/messaging_handler.rb
----------------------------------------------------------------------
diff --git a/proton-c/bindings/ruby/lib/core/messaging_handler.rb b/proton-c/bindings/ruby/lib/core/messaging_handler.rb
index fd33661..66d9ce2 100644
--- a/proton-c/bindings/ruby/lib/core/messaging_handler.rb
+++ b/proton-c/bindings/ruby/lib/core/messaging_handler.rb
@@ -177,7 +177,8 @@ module Qpid::Proton
# @!group Unhandled events
# @!method on_error(error_condition)
- # The fallback error handler when no specific on_xxx_error is defined
+ # Called on an error if no more specific on_xxx_error method is provided.
+ # If on_error() is also not defined, the connection is closed with error_condition
# @param error_condition [Condition] Provides information about the error.
# @!method on_unhandled(method_name, *args)
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/26138b75/proton-c/bindings/ruby/lib/core/receiver.rb
----------------------------------------------------------------------
diff --git a/proton-c/bindings/ruby/lib/core/receiver.rb b/proton-c/bindings/ruby/lib/core/receiver.rb
index 649219f..eb01e75 100644
--- a/proton-c/bindings/ruby/lib/core/receiver.rb
+++ b/proton-c/bindings/ruby/lib/core/receiver.rb
@@ -35,11 +35,10 @@ module Qpid::Proton
# @param address [String] address of the source to receive from
# @overload open_receiver(opts)
# @param opts [Hash] Receiver options, see {Receiver#open}
- # @option opts [Boolean] :credit_window automatically maintain this much credit
+ # @option opts [Integer] :credit_window automatically maintain this much credit
# for messages to be pre-fetched while the current message is processed.
# @option opts [Boolean] :auto_accept if true, deliveries that are not settled by
# the application in {MessagingHandler#on_message} are automatically accepted.
- # @option opts [Integer] :credit_window (10) automatically replenish credits for flow control.
# @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}
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org