qpid_proton 0.9.0 → 0.10

data/lib/handler/incoming_message_handler.rb

@@ -0,0 +1,74 @@
+#--
+# 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::Handler
+
+  # A utility for simpler and more intuitive handling of delivery events
+  # related to incoming messages.
+  #
+  class IncomingMessageHandler < Qpid::Proton::BaseHandler
+
+    include Acking
+
+    def initialize(auto_accept = true, delegate = nil)
+      @delegate = delegate
+      @auto_accept = auto_accept
+    end
+
+    def on_delivery(event)
+      delivery = event.delivery
+      return unless delivery.link.receiver?
+      if delivery.readable? && !delivery.partial?
+        event.message = Qpid::Proton::Util::Engine.receive_message(delivery)
+        if event.link.local_closed?
+          if @auto_accept
+            delivery.update(Qpid::Proton::Disposition::RELEASED)
+            delivery.settle
+          end
+        else
+          begin
+            self.on_message(event)
+            if @auto_accept
+              delivery.update(Qpid::Proton::Disposition::ACCEPTED)
+              delivery.settle
+            end
+          rescue Qpid::Proton::Reject
+            delivery.update(Qpid::Proton::Disposition::REJECTED)
+            delivery.settle
+          rescue Qpid::Proton::Release
+            delivery.update(Qpid::Proton::Disposition::MODIFIED)
+            delivery.settle
+          end
+        end
+      elsif delivery.updated? && delivery.settled?
+        self.on_settled(event)
+      end
+    end
+
+    def on_message(event)
+      Qpid::Proton::Event.dispatch(@delegate, :on_message, event) if !@delegate.nil?
+    end
+
+    def on_settled(event)
+      Qpid::Proton::Event.dispatch(@delegate, :on_settled, event) if !@delegate.nil?
+    end
+
+  end
+
+end

data/lib/handler/messaging_handler.rb

@@ -0,0 +1,218 @@
+#--
+# 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::Handler
+
+  # A general purpose handler that simplifies processing events.
+  #
+  # @example
+  #
+  class MessagingHandler < Qpid::Proton::BaseHandler
+
+    attr_reader :handlers
+
+    # Creates a new instance.
+    #
+    # @param [Fixnum] prefetch
+    # @param [Boolean] auto_accept
+    # @param [Boolean] auto_settle
+    # @param [Boolean] peer_close_is_error
+    #
+    def initialize(prefetch = 10, auto_accept = true, auto_settle = true, peer_close_is_error = false)
+      @handlers = Array.new
+      @handlers << CFlowController.new(prefetch) unless prefetch.zero?
+      @handlers << EndpointStateHandler.new(peer_close_is_error, self)
+      @handlers << IncomingMessageHandler.new(auto_accept, self)
+      @handlers << OutgoingMessageHandler.new(auto_settle,self)
+    end
+
+    # Called when the peer closes the connection with an error condition.
+    #
+    # @param event [Qpid::Proton::Event::Event] The event.
+    #
+    def on_connection_error(event)
+      EndpointStateHandler.print_error(event.connection, "connection")
+    end
+
+      # Called when the peer closes the session with an error condition.
+      #
+      # @param event [Qpid:Proton::Event::Event] The event.
+      #
+    def on_session_error(event)
+      EndpointStateHandler.print_error(event.session, "session")
+      event.connection.close
+    end
+
+    # Called when the peer closes the link with an error condition.
+    #
+    # @param event [Qpid::Proton::Event::Event] The event.
+    #
+    def on_link_error(event)
+      EndpointStateHandler.print_error(event.link, "link")
+      event.connection.close
+    end
+
+    # Called when the event loop starts.
+    #
+    # @param event [Qpid::Proton::Event::Event] The event.
+    #
+    def on_reactor_init(event)
+      self.on_start(event)
+    end
+
+    # Called when the event loop starts.
+    #
+    # This method needs to be overridden.
+    #
+    # @param event [Qpid::Proton::Event::Event] The event.
+    #
+    def on_start(event)
+    end
+
+    # Called when the connection is closed.
+    #
+    # This method needs to be overridden.
+    #
+    # @param event [Qpid::Proton::Event::Event] The event.
+    #
+    def on_connection_closed(event)
+    end
+
+    # Called when the session is closed.
+    #
+    # This method needs to be overridden.
+    #
+    # @param event [Qpid::Proton::Event::Event] The event.
+    #
+    def on_session_closed(event)
+    end
+
+    # Called when the link is closed.
+    #
+    # This method needs to be overridden.
+    #
+    # @param event [Qpid::Proton::Event::Event] The event.
+    #
+    def on_link_closed(event)
+    end
+
+    # Called when the peer initiates the closing of the connection.
+    #
+    # This method needs to be overridden.
+    #
+    # @param event [Qpid::Proton::Event::Event] The event.
+    #
+    def on_connection_closing(event)
+    end
+
+    # Called when the peer initiates the closing of the session.
+    #
+    # This method needs to be overridden.
+    #
+    # @param event [Qpid::Proton::Event::Event] The event.
+    #
+    def on_session_closing(event)
+    end
+
+    # Called when the peer initiates the closing of the link.
+    #
+    # This method needs to be overridden.
+    #
+    # @param event [Qpid::Proton::Event::Event] The event.
+    #
+    def on_link_closing(event)
+    end
+
+    # Called when the socket is disconnected.
+    #
+    # This method needs to be overridden.
+    #
+    # @param event [Qpid::Proton::Event::Event] The event.
+    #
+    def on_disconnected(event)
+    end
+
+    # Called when the sender link has credit and messages can therefore
+    # be transferred.
+    #
+    # This method needs to be overridden.
+    #
+    # @param event [Qpid::Proton::Event::Event] The event.
+    #
+    def on_sendable(event)
+    end
+
+    # Called when the remote peer accepts an outgoing message.
+    #
+    # This method needs to be overridden.
+    #
+    # @param event [Qpid::Proton::Event::Event] The event.
+    #
+    def on_accepted(event)
+    end
+
+    # Called when the remote peer rejects an outgoing message.
+    #
+    # This method needs to be overridden.
+    #
+    # @param event [Qpid::Proton::Event::Event] The event.
+    #
+    def on_rejected(event)
+    end
+
+    # Called when the remote peer releases an outgoing message.
+    #
+    # Note that this may be in response to either the RELEASE or
+    # MODIFIED state as defined by the AMPQ specification.
+    #
+    # This method needs to be overridden.
+    #
+    # @param event [Qpid::Proton::Event::Event] The event.
+    #
+    def on_released(event)
+    end
+
+    # Called when the remote peer has settled hte outgoing message.
+    #
+    # This is the point at which it should never be retransmitted.
+    #
+    # This method needs to be overridden.
+    #
+    # @param event [Qpid::Proton::Event::Event] The event.
+    #
+    def on_settled(event)
+    end
+
+    # Called when a message is received.
+    #
+    # The message itself can be obtained as a property on the event. For
+    # the purpose of referring to this message in further actions, such as
+    # explicitly accepting it) the delivery should be used. This is also
+    # obtainable vi a property on the event.
+    #
+    # This method needs to be overridden.
+    #
+    # @param event [Qpid::Proton::Event::Event] The event.
+    #
+    def on_message(event)
+    end
+
+  end
+
+end

data/lib/handler/outgoing_message_handler.rb

@@ -0,0 +1,98 @@
+#--
+# 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::Handler
+
+  # A utility for simpler and more intuitive handling of delivery events
+  # related to outgoing messages.
+  #
+  class OutgoingMessageHandler < Qpid::Proton::BaseHandler
+
+    def initialize(auto_settle = true, delegate = nil)
+      @auto_settle = auto_settle
+      @delegate = delegate
+    end
+
+    def on_link_flow(event)
+      self.on_sendable(event) if event.link.sender? && event.link.credit > 0
+    end
+
+    def on_delivery(event)
+      delivery = event.delivery
+      if delivery.link.sender? && delivery.updated?
+        if delivery.remote_accepted?
+          self.on_accepted(event)
+        elsif delivery.remote_rejected?
+          self.on_rejected(event)
+        elsif delivery.remote_released? || delivery.remote_modified?
+          self.on_released(event)
+        end
+        self.on_settled(event) if delivery.settled?
+        delivery.settle if @auto_settle
+      end
+    end
+
+    # Called when the sender link has credit and messages and be transferred.
+    #
+    # @param event [Qpid::Proton::Event::Event] The event.
+    #
+    def on_sendable(event)
+      Qpid::Proton::Event.dispatch(@delegate, :on_sendable, event) if !@delegate.nil?
+    end
+
+    # Called when the remote peer accepts a sent message.
+    #
+    # @param event [Qpid::Proton::Event::Event] The event.
+    #
+    def on_accepted(event)
+      Qpid::Proton::Event.dispatch(@delegate, :on_accepted, event) if !@delegate.nil?
+    end
+
+    # Called when the remote peer rejects a sent message.
+    #
+    # @param event [Qpid::Proton::Event::Event] The event.
+    #
+    def on_rejected(event)
+      Qpid::Proton::Event.dispatch(@delegate, :on_rejected, event) if !@delegate.nil?
+    end
+
+    # Called when the remote peer releases an outgoing message.
+    #
+    # Note that this may be in resposnse to either the REELAASE or MODIFIED
+    # state as defined by the AMQP specification.
+    #
+    # @param event [Qpid::Proton::Event::Event] The event.
+    #
+    def on_released(event)
+      Qpid::Proton::Event.dispatch(@delegate, :on_released, event) if !@delegate.nil?
+    end
+
+    # Called when the remote peer has settled the outgoing message.
+    #
+    # This is the point at which it should never be retransmitted.
+    #
+    # @param event [Qpid::Proton::Event::Event] The event.
+    #
+    def on_settled(event)
+      Qpid::Proton::Event.dispatch(@delegate, :on_settled, event) if !@delegate.nil?
+    end
+
+  end
+
+end

data/lib/handler/wrapped_handler.rb

@@ -0,0 +1,76 @@
+#--
+# 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::Handler
+
+  class WrappedHandler
+
+    # @private
+    include Qpid::Proton::Util::Wrapper
+
+    def self.wrap(impl, on_error = nil)
+      return nil if impl.nil?
+
+      result = self.fetch_instance(impl) || WrappedHandler.new(impl)
+      result.on_error = on_error
+      return result
+    end
+
+    include Qpid::Proton::Util::Handler
+
+    def initialize(impl_or_constructor)
+      if impl_or_constructor.is_a?(Method)
+        @impl = impl_or_constructor.call
+      else
+        @impl = impl_or_constructor
+        Cproton.pn_incref(@impl)
+      end
+      @on_error = nil
+      self.class.store_instance(self)
+    end
+
+    def add(handler)
+      return if handler.nil?
+
+      impl = chandler(handler, self.method(:_on_error))
+      Cproton.pn_handler_add(@impl, impl)
+      Cproton.pn_decref(impl)
+    end
+
+    def clear
+      Cproton.pn_handler_clear(@impl)
+    end
+
+    def on_error=(on_error)
+      @on_error = on_error
+    end
+
+    private
+
+    def _on_error(info)
+      if self.has?['on_error']
+        self['on_error'].call(info)
+      else
+        raise info
+      end
+    end
+
+  end
+
+end