You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by mc...@apache.org on 2015/05/20 17:29:10 UTC
[17/25] qpid-proton git commit: PROTON-799: Added the Receiver class
to the Ruby engine APIs.
PROTON-799: Added the Receiver class to the Ruby engine APIs.
Project: http://git-wip-us.apache.org/repos/asf/qpid-proton/repo
Commit: http://git-wip-us.apache.org/repos/asf/qpid-proton/commit/43b11f86
Tree: http://git-wip-us.apache.org/repos/asf/qpid-proton/tree/43b11f86
Diff: http://git-wip-us.apache.org/repos/asf/qpid-proton/diff/43b11f86
Branch: refs/heads/ruby-engine-apis
Commit: 43b11f8688ff44ac191e4129fda65d4709597580
Parents: 9063f8b
Author: Darryl L. Pierce <mc...@gmail.com>
Authored: Tue Jan 20 09:22:49 2015 -0500
Committer: Darryl L. Pierce <mc...@gmail.com>
Committed: Wed May 20 11:11:42 2015 -0400
----------------------------------------------------------------------
proton-c/bindings/ruby/lib/core/receiver.rb | 95 ++++++++++++++++++++++++
proton-c/bindings/ruby/lib/qpid_proton.rb | 1 +
2 files changed, 96 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/43b11f86/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
new file mode 100644
index 0000000..ca7c5e1
--- /dev/null
+++ b/proton-c/bindings/ruby/lib/core/receiver.rb
@@ -0,0 +1,95 @@
+#--
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#++
+
+module Qpid::Proton
+
+ # The receiving endpoint.
+ #
+ # @see Sender
+ #
+ class Receiver < Link
+
+ # @private
+ include Util::SwigHelper
+
+ # @private
+ PROTON_METHOD_PREFIX = "pn_link"
+
+ # @!attribute drain
+ #
+ # The drain mode.
+ #
+ # If a receiver is in drain mode, then the sending endpoint of a link must
+ # immediately use up all available credit on the link. If this is not
+ # possible, the excess credit must be returned by invoking #drained.
+ #
+ # Only the receiving endpoint can set the drain mode.
+ #
+ # @return [Boolean] True if drain mode is set.
+ #
+ proton_accessor :drain
+
+ # @!attribute [r] draining?
+ #
+ # Returns if a link is currently draining.
+ #
+ # A link is defined to be draining when drain mode is set to true and
+ # the sender still has excess credit.
+ #
+ # @return [Boolean] True if the receiver is currently draining.
+ #
+ proton_caller :draining?
+
+ # Grants credit for incoming deliveries.
+ #
+ # @param n [Fixnum] The amount to increment the link credit.
+ #
+ def flow(n)
+ Cproton.pn_link_flow(@impl, n)
+ end
+
+ # Allows receiving up to the specified limit of data from the remote
+ # endpoint.
+ #
+ # Note that large messages can be streamed across the network, so just
+ # because there is no data to read does not imply the message is complete.
+ #
+ # To ensure the entirety of the message data has been read, either call
+ # #receive until nil is returned, or verify that #partial? is false and
+ # Delivery#pending is 0.
+ #
+ # @param limit [Fixnum] The maximum bytes to receive.
+ #
+ # @return [Fixnum, nil] The number of bytes received, or nil if the end of
+ # the stream was reached.t
+ #
+ # @see Deliver#pending To see how much buffer space is needed.
+ #
+ # @raise [LinkError] If an error occurs.
+ #
+ def receive(limit)
+ (n, bytes) = Cproton.pn_link_recv(@impl, limit)
+ return nil if n == Qpid::Proton::Error::EOS
+ raise LinkError.new("[#{n}]: #{Cproton.pn_link_error(@impl)}") if n < 0
+ return bytes
+ end
+
+ end
+
+end
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/43b11f86/proton-c/bindings/ruby/lib/qpid_proton.rb
----------------------------------------------------------------------
diff --git a/proton-c/bindings/ruby/lib/qpid_proton.rb b/proton-c/bindings/ruby/lib/qpid_proton.rb
index 39ef351..ed8532f 100644
--- a/proton-c/bindings/ruby/lib/qpid_proton.rb
+++ b/proton-c/bindings/ruby/lib/qpid_proton.rb
@@ -61,6 +61,7 @@ require "core/disposition"
require "core/delivery"
require "core/link"
require "core/sender"
+require "core/receiver"
# Messenger API classes
require "messenger/filters"
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org