qpid_proton 0.9.0 → 0.10

data/lib/event/event_base.rb

@@ -0,0 +1,91 @@
+#--
+# 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::Event
+
+  # @private
+  def self.dispatch(handler, method, *args)
+    args = args.last unless args.nil?
+    if handler.respond_to? method.to_sym
+      return handler.__send__(method, args)
+    elsif handler.respond_to? :on_unhandled
+      return handler.__send__(:on_unhandled, method, args)
+    end
+  end
+
+  # EventBase is the foundation for creating application-specific events.
+  #
+  # @example
+  #
+  #   # SCENARIO: A continuation of the example in EventType.
+  #   #
+  #   #           An Event class is defined to handle receiving encrypted
+  #   #           data from a remote endpoint.
+  #
+  #   class EncryptedDataEvent < EventBase
+  #     def initialize(message)
+  #       super(EncryptedDataEvent, message,
+  #             Qpid::Proton::Event::ENCRYPTED_RECV)
+  #     end
+  #   end
+  #
+  #   # at another point, when encrypted data is received
+  #   msg = Qpid::Proton::Message.new
+  #   msg.decode(link.receive(link.pending))
+  #   if encrypted?(msg)
+  #     collector.put(EncryptedDataEvent.new(msg)
+  #   end
+  #
+  # @see EventType The EventType class for how ENCRYPTED_RECV was defined.
+  #
+  class EventBase
+
+    # Returns the name for the class associated with this event.
+    attr_reader :class_name
+
+    # Returns the associated context object for the event.
+    attr_reader :context
+
+    # Returns the type of the event.
+    attr_reader :type
+
+    # Creates a new event with the specific class_name and context of the
+    # specified type.
+    #
+    # @param class_name [String] The name of the class.
+    # @param context [Object] The event context.
+    # @param type [EventType] The event type.
+    #
+    def initialize(class_name, context, type)
+      @class_name = class_name
+      @context = context
+      @type = type
+    end
+
+    # Invokes the type-specific method on the provided handler.
+    #
+    # @param handler [Object] The handler to be notified of this event.
+    #
+    def dispatch(handler)
+      Qpid::Proton.dispatch(handler, @type.method, self)
+    end
+
+  end
+
+end

data/lib/event/event_type.rb

@@ -0,0 +1,71 @@
+#--
+# 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::Event
+
+  # Manages the association between an Event and the method which should
+  # process on the context object associated with an occurance of the event.
+  #
+  # Each type is identified by a unique #type value.
+  #
+  # @example
+  #
+  #   # SCENARIO: A part of an application handles extracting and decrypting
+  #   #            data received from a remote endpoint.
+  #   #
+  #   #            An EventType is created to notify handlers that such a
+  #   #            situation has occurred.
+  #
+  #   ENCRYPTED_RECV = 10000 # the unique constant value for the event
+  #
+  #   # create a new event type which, when it occurs, invokes a method
+  #   # named :on_encrypted_data when a handler is notified of its occurrance
+  #   Qpid::Proton::Event::ENCRYPTED_RECV =
+  #     Qpid::Proton::Event::EventType.new(ENCRYPTED_RECV, :on_encrypted_data)
+  #
+  # @see EventBase EventBase for the rest of this example.
+  # @see Qpid::Proton::Event::Event The Event class for more details on events.
+  #
+  class EventType
+
+    # The method to invoke on any potential handler.
+    attr_reader :method
+    attr_reader :number
+
+    def initialize(number, method)
+      @number = number
+      @name = Cproton.pn_event_type_name(@number)
+      @method = method
+      @@types ||= {}
+      @@types[number] = self
+    end
+
+    # @private
+    def to_s
+      @name
+    end
+
+    # @private
+    def self.by_type(type) # :nodoc:
+      @@types[type]
+    end
+
+  end
+
+end

data/lib/handler/acking.rb

@@ -0,0 +1,70 @@
+#--
+# 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
+
+  # Mixing that provides methods for acknowledging a delivery.
+  #
+  module Acking
+
+    # Accept the receivered message.
+    #
+    # @param delivery [Qpid::Proton::Delivery] The delivery.
+    #
+    def accept(delivery)
+      self.settle(delivery, Qpid::Proton::Delivery::ACCEPTED)
+    end
+
+    # Rejects a received message that is considered invalid or unprocessable.
+    #
+    # @param delivery [Qpid::Proton::Delivery] The delivery.
+    #
+    def reject(delivery)
+      self.settle(delivery, Qpid::Proton::Delivery::REJECTED)
+    end
+
+    # Releases a received message, making it available at the source for any
+    # other interested receiver.
+    #
+    # @param delivery [Qpid::Proton::Delivery] The delivery
+    # @param delivered [Boolean] True if this was considered a delivery
+    #   attempt.
+    #
+    def release(delivery, delivered = true)
+      if delivered
+        self.settle(delivery, Qpid::Proton::Delivery::MODIFIED)
+      else
+        self.settle(delivery, Qpid::Proton::Delivery::RELEASED)
+      end
+    end
+
+    # Settles the specified delivery. Updates the delivery state if a state
+    # is specified.
+    #
+    # @param delivery [Qpid::Proton::Delivery] The delivery.
+    # @param state [Fixnum] The delivery state.
+    #
+    def settle(delivery, state = nil)
+      delivery.update(state) unless state.nil?
+      delivery.settle
+    end
+
+  end
+
+end

data/lib/handler/c_adaptor.rb

@@ -0,0 +1,47 @@
+#--
+# 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
+
+  # @private
+  class CAdaptor
+
+    def initialize(handler, on_error = nil)
+      @handler = handler
+      @on_error = on_error
+    end
+
+    def dispatch(cevent, ctype)
+      event = Qpid::Proton::Event::Event.wrap(cevent, ctype)
+      # TODO add a variable to enable this programmatically
+      # print "EVENT: #{event} going to #{@handler}\n"
+      event.dispatch(@handler)
+    end
+
+    def exception(error)
+      if @on_error.nil?
+        raise error
+      else
+        @on_error.call(error)
+      end
+    end
+
+  end
+
+end

data/lib/handler/c_flow_controller.rb

@@ -0,0 +1,33 @@
+#--
+# 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
+
+  # @private
+  class CFlowController < Qpid::Proton::Handler::WrappedHandler
+
+    include Qpid::Proton::Util::Wrapper
+
+    def initialize(window = 1024)
+      super(Cproton.pn_flowcontroller(window))
+    end
+
+  end
+
+end

data/lib/handler/endpoint_state_handler.rb

@@ -0,0 +1,217 @@
+#--
+# 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 that exposes endpoint events; i.e., the open/close of a link,
+  # session or connection, in a more intuitive manner.
+  #
+  # A XXX_opened method will be called when both local and remote peers have
+  # opened the link, session or connection. This can be used to confirm a
+  # locally initiated action for example.
+  #
+  # A XXX_opening method will be called when the remote peer has requested
+  # an open that was not initiated locally. By default this will simply open
+  # locally, which then trigtgers the XXX_opened called.
+  #
+  # The same applies to close.
+  #
+  class EndpointStateHandler < Qpid::Proton::BaseHandler
+
+    def initialize(peer_close_is_error = false, delegate = nil)
+      @delegate = delegate
+      @peer_close_is_error = peer_close_is_error
+    end
+
+    def self.print_error(endpoint, endpoint_type)
+      if !endpoint.remote_condition.nil?
+      elsif self.local_endpoint?(endpoint) && endpoint.remote_closed?
+        logging.error("#{endpoint_type} closed by peer")
+      end
+    end
+
+    def on_link_remote_close(event)
+      if !event.link.remote_condition.nil?
+        self.on_link_error(event)
+      elsif event.link.local_closed?
+        self.on_link_closed(event)
+      else
+        self.on_link_closing(event)
+      end
+      event.link.close
+    end
+
+    def on_session_remote_close(event)
+      if !event.session.remote_condition.nil?
+        self.on_session_error(event)
+      elsif event.session.local_closed?
+        self.on_session_closed(event)
+      else
+        self.on_session_closing(event)
+      end
+      event.session.close
+    end
+
+    def on_connection_remote_close(event)
+      if !event.connection.remote_condition.nil?
+        self.on_connection_error(event)
+      elsif event.connection.local_closed?
+        self.on_connection_closed(event)
+      else
+        self.on_connection_closing(event)
+      end
+      event.connection.close
+    end
+
+    def on_connection_local_open(event)
+      self.on_connection_opened(event) if event.connection.remote_active?
+    end
+
+    def on_connection_remote_open(event)
+      if !(event.connection.state & Qpid::Proton::Endpoint::LOCAL_ACTIVE).zero?
+        self.on_connection_opened(event)
+      elsif event.connection.local_uninit?
+        self.on_connection_opening(event)
+        event.connection.open
+      end
+    end
+
+    def on_session_local_open(event)
+      self.on_session_opened(event) if event.session.remote_active?
+    end
+
+    def on_session_remote_open(event)
+      if !(event.session.state & Qpid::Proton::Endpoint::LOCAL_ACTIVE).zero?
+        self.on_session_opened(event)
+      elsif event.session.local_uninit?
+        self.on_session_opening(event)
+        event.session.open
+      end
+    end
+
+    def on_link_local_open(event)
+      self.on_link_opened(event) if event.link.remote_active?
+    end
+
+    def on_link_remote_open(event)
+      if !(event.link.state & Qpid::Proton::Endpoint::LOCAL_ACTIVE).zero?
+        self.on_link_opened(event)
+      elsif event.link.local_uninit?
+        self.on_link_opening(event)
+        event.link.open
+      end
+    end
+
+    def on_connection_opened(event)
+      Qpid::Proton::Event.dispatch(@delegate, :on_session_opened, event) if !@delegate.nil?
+    end
+
+    def on_session_opened(event)
+      Qpid::Proton::Event.dispatch(@delegate, :on_session_opened, event) if !@delegate.nil?
+    end
+
+    def on_link_opened(event)
+      Qpid::Proton::Event.dispatch(@delegate, :on_link_opened, event) if !@delegate.nil?
+    end
+
+    def on_connection_opening(event)
+      Qpid::Proton::Event.dispatch(@delegate, :on_connection_opening, event) if !@delegate.nil?
+    end
+
+    def on_session_opening(event)
+      Qpid::Proton::Event.dispatch(@delegate, :on_session_opening, event) if !@delegate.nil?
+    end
+
+    def on_link_opening(event)
+      Qpid::Proton::Event.dispatch(@delegate, :on_link_opening, event) if !@delegate.nil?
+    end
+
+    def on_connection_error(event)
+      if !@delegate.nil?
+        Qpid::Proton::Event.dispatch(@delegate, :on_connection_error, event)
+      else
+        self.log_error(event.connection, "connection")
+      end
+    end
+
+    def on_session_error(event)
+      if !@delegate.nil?
+        Qpid::Proton::Event.dispatch(@delegate, :on_session_error, event)
+      else
+        self.log_error(event.session, "session")
+        event.connection.close
+      end
+    end
+
+    def on_link_error(event)
+      if !@delegate.nil?
+        Qpid::Proton::Event.dispatch(@delegate, :on_link_error, event)
+      else
+        self.log_error(event.link, "link")
+        event.conneciton.close
+      end
+    end
+
+    def on_connection_closed(event)
+      Qpid::Proton::Event.dispatch(@delegate, :on_connection_closed, event) if !@delegate.nil?
+    end
+
+    def on_session_closed(event)
+      Qpid::Proton::Event.dispatch(@delegate, :on_session_closed, event) if !@delegate.nil?
+    end
+
+    def on_link_closed(event)
+      Qpid::Proton::Event.dispatch(@delegate, :on_link_closed, event) if !@delegate.nil?
+    end
+
+    def on_connection_closing(event)
+      if !@delegate.nil?
+        Qpid::Proton::Event.dispatch(@delegate, :on_connection_closing, event)
+      elsif @peer_close_is_error
+        self.on_connection_error(event)
+      end
+    end
+
+    def on_session_closing(event)
+      if !@delegate.nil?
+        Qpid::Proton::Event.dispatch(@delegate, :on_session_closing, event)
+      elsif @peer_close_is_error
+        self.on_session_error(event)
+      end
+    end
+
+    def on_link_closing(event)
+      if !@delegate.nil?
+        Qpid::Proton::Event.dispatch(@delegate, :on_link_closing, event)
+      elsif @peer_close_is_error
+        self.on_link_error(event)
+      end
+    end
+
+    def on_transport_tail_closed(event)
+      self.on_transport_closed(event)
+    end
+
+    def on_transport_closed(event)
+      Qpid::Proton::Event.dispatch(@delegate, :on_disconnected, event) if !@delegate.nil?
+    end
+
+  end
+
+end