qpid_proton 0.18.1 → 0.19.0

data/lib/util/{handler.rb → deprecation.rb}

@@ -1,4 +1,3 @@
-#--
 # 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
@@ -15,27 +14,35 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-#++
 
 module Qpid::Proton::Util
-
   # @private
-  module Handler
+  module Deprecation
+    MATCH_DIR = /#{File.dirname(File.dirname(__FILE__))}/
+
+    DEPRECATE_FULL_TRACE = false
 
-    def chandler(handler, on_error)
-      return nil if handler.nil?
+    def self.deprecated(old, new=nil)
+      replace = new ? "use `#{new}`" : "internal use only"
+
+      from = DEPRECATE_FULL_TRACE ? caller(2).join("\n") : caller.find { |l| not MATCH_DIR.match(l) }
+      warn "[DEPRECATION] `#{old}` is deprecated, #{replace}. Called from #{from}"
+    end
 
-      if handler.instance_of?(Qpid::Proton::Handler::WrappedHandler)
-        impl = handler.impl
-        Cproton.pn_incref(impl)
-        return impl
-      else
-        cadaptor = Qpid::Proton::Handler::CAdaptor.new(handler, on_error)
-        rbhandler = Cproton.pn_rbhandler(cadaptor)
-        return rbhandler
+    def deprecated(*arg) Deprecation.deprecated(*arg); end
+
+    module ClassMethods
+      def deprecated_alias(bad, good)
+        bad, good = bad.to_sym, good.to_sym
+        define_method(bad) do |*args, &block|
+          self.deprecated bad, good
+          self.__send__(good, *args, &block)
+        end
       end
     end
 
+    def self.included(other)
+      other.extend ClassMethods
+    end
   end
-
 end

data/lib/util/error_handler.rb

@@ -1,4 +1,3 @@
-#--
 # 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
@@ -15,7 +14,7 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-#++
+
 
 module Qpid::Proton::Util
 
@@ -24,35 +23,15 @@ module Qpid::Proton::Util
   # @private
   module ErrorHandler
 
-    def self.included(base)
-      base.extend(self)
-
-      unless defined? base.to_be_wrapped
-        class << base
-          @@to_be_wrapped = []
-        end
-      end
-
-      define_method :method_added do |name|
-        if (!@@to_be_wrapped.nil?) && (@@to_be_wrapped.include? name)
-          @@to_be_wrapped.delete name
-          create_exception_handler_wrapper(name)
-        end
-      end
-    end
+    def self.included(other) other.extend(self); end
 
     def can_raise_error(method_names, options = {})
       error_class = options[:error_class]
       below = options[:below] || 0
       # coerce the names to be an array
       Array(method_names).each do |method_name|
-        # if the method doesn't already exist then queue this aliasing
-        unless self.method_defined? method_name
-          @@to_be_wrapped ||= []
-          @@to_be_wrapped << method_name
-        else
-          create_exception_handler_wrapper(method_name, error_class, below)
-        end
+        raise "missing method #{method_name.inspect}" unless method_defined?(method_name) || private_method_defined?(method_name)
+        create_exception_handler_wrapper(method_name, error_class, below)
       end
     end
 

data/lib/util/timeout.rb

@@ -1,4 +1,3 @@
-#--
 # 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
@@ -15,7 +14,7 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-#++
+
 
 module Qpid::Proton::Util
 

data/lib/util/version.rb

@@ -1,4 +1,3 @@
-#--
 # 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
@@ -15,7 +14,7 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-#++
+
 
 module Qpid::Proton::Util
 

data/lib/util/wrapper.rb

@@ -1,4 +1,3 @@
-#--
 # 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
@@ -15,49 +14,48 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-#++
 
-module Qpid::Proton::Util
 
-  # @private
-  module Wrapper
+module Qpid::Proton
+  module Util
 
     # @private
-    def impl=(impl)
-      @impl = impl
-    end
-
-    # @private
-    def impl
-      @impl
-    end
+    # Class methods to help wrapper classes define forwarding methods to proton-C functions
+    #
+    # The extending class must define PROTON_METHOD_PREFIX, the functions here
+    # make it easy to define ruby methods to forward calls to C functions.
+    #
+    module SWIGClassHelper
+      # Define ruby method +name+ to forward arguments to
+      # CProton.PROTON_METHOD_PREFIX_+pn_name+(@impl, ...)
+      def proton_forward(name, pn_name)
+        pn_name = pn_name[0..-2] if pn_name.to_s.end_with? "?" # Drop trailing ? for ruby bool methods
+        pn_name = "#{self::PROTON_METHOD_PREFIX}_#{pn_name}".to_sym
+        define_method(name.to_sym) { |*args| Cproton.__send__(pn_name, @impl, *args) }
+      end
 
-    def self.registry
-      @registry ||= {}
-    end
+      def proton_caller(*names) names.each { |name| proton_forward(name, name) }; end
+      def proton_set(*names) names.each { |name| proton_forward("#{name}=", "set_#{name}") }; end
+      def proton_get(*names) names.each { |name| proton_forward(name, "get_#{name}") }; end
+      def proton_is(*names) names.each { |name| proton_forward("#{name}?", "is_#{name}") }; end
+      def proton_set_get(*names) names.each { |name| proton_get(name); proton_set(name) }; end
+      def proton_set_is(*names) names.each { |name| proton_is(name); proton_set(name) }; end
 
-    def self.included(base)
-      base.extend(ClassMethods)
-    end
+      # Store ruby wrappers as attachments so they can be retrieved from the C pointer.
+      #
+      # Wrappers are stored in a registry using a key. The key is then attached to
+      # the Proton structure as a record. That record lives for as long as the
+      # Proton structure lives, and when the structure is released the record acts
+      # as hook to also delete the Ruby wrapper object from the registry.
 
-    # Adds methods to the target class for storing and retrieving pure Ruby
-    # wrappers to underlying Proton structures.
-    #
-    # Such wrappers are stored in a registry using a key. The key is then
-    # attached to the Proton structure as a record. That record lives for as
-    # long as the Proton structure lives, and when the structure is released
-    # the record acts as hook to also delete the Ruby wrapper object from the
-    # registry.
-    #
-    # @private
-    #
-    module ClassMethods
+      @@registry = {}
 
       # @private
       def get_key(impl)
         ("%032x" % Cproton.pni_address_of(impl))
       end
 
+      # @private
       # Stores the given object for later retrieval.
       #
       # @param object [Object] The object.
@@ -76,7 +74,7 @@ module Qpid::Proton::Util
           Cproton.pn_record_def(record, RBCTX, Cproton.Pn_rbkey__class());
           Cproton.pn_record_set(record, RBCTX, rbkey)
         end
-        Qpid::Proton::Util::Wrapper.registry[registry_key] = object
+        @@registry[registry_key] = object
       end
 
       # Retrieves the wrapper object with the supplied Proton struct.
@@ -101,9 +99,9 @@ module Qpid::Proton::Util
           registry_key = get_key(impl)
         end
         # if the object's not in the registry then return
-        return nil unless Qpid::Proton::Util::Wrapper.registry.has_key?(registry_key)
+        return nil unless @@registry.has_key?(registry_key)
 
-        result = Qpid::Proton::Util::Wrapper.registry[registry_key]
+        result = @@registry[registry_key]
         # result = nil unless result.weakref_alive?
         if result.nil?
           raise Qpid::Proton::ProtonError.new("missing object for key=#{registry_key}")
@@ -113,12 +111,34 @@ module Qpid::Proton::Util
         end
         return result
       end
-
+      RBCTX = self.hash.to_i
     end
 
-  end
+    # @private
+    module Wrapper
 
-  # @private
-  RBCTX = Wrapper.hash.to_i
+      def self.included(base)
+        base.extend(SWIGClassHelper)
+      end
+
+      attr_accessor :impl
 
+      def inspect
+        return "#{self.class}<nil>" unless @impl
+        pstr = Cproton.pn_string("")
+        begin
+          Cproton.pn_inspect(@impl, pstr)
+          return Cproton.pn_string_get(pstr)
+        ensure
+          Cproton.pn_free(pstr)
+        end
+      end
+
+      def to_s() inspect; end
+
+      def self.registry
+        @registry ||= {}
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qpid_proton
 version: !ruby/object:Gem::Version
-  version: 0.18.1
+  version: 0.19.0
 platform: ruby
 authors:
 - Darryl L. Pierce
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-14 00:00:00.000000000 Z
+date: 2018-01-02 00:00:00.000000000 Z
 dependencies: []
 description: |
   Proton is a high performance, lightweight messaging library. It can be used in
@@ -30,67 +30,50 @@ files:
 - ext/cproton/extconf.rb
 - lib/codec/data.rb
 - lib/codec/mapping.rb
-- lib/core/base_handler.rb
+- lib/core/condition.rb
 - lib/core/connection.rb
+- lib/core/connection_driver.rb
+- lib/core/container.rb
 - lib/core/delivery.rb
 - lib/core/disposition.rb
 - lib/core/endpoint.rb
+- lib/core/event.rb
 - lib/core/exceptions.rb
 - lib/core/link.rb
+- lib/core/listener.rb
 - lib/core/message.rb
+- lib/core/messaging_handler.rb
 - lib/core/receiver.rb
 - lib/core/sasl.rb
-- lib/core/selectable.rb
 - lib/core/sender.rb
 - lib/core/session.rb
 - lib/core/ssl.rb
 - lib/core/ssl_details.rb
 - lib/core/ssl_domain.rb
 - lib/core/terminus.rb
+- lib/core/tracker.rb
+- lib/core/transfer.rb
 - lib/core/transport.rb
+- lib/core/uri.rb
 - lib/core/url.rb
-- lib/event/collector.rb
-- lib/event/event.rb
-- lib/event/event_base.rb
-- lib/event/event_type.rb
-- lib/handler/acking.rb
-- lib/handler/c_adaptor.rb
-- lib/handler/c_flow_controller.rb
-- lib/handler/endpoint_state_handler.rb
-- lib/handler/incoming_message_handler.rb
+- lib/handler/adapter.rb
+- lib/handler/messaging_adapter.rb
 - lib/handler/messaging_handler.rb
-- lib/handler/outgoing_message_handler.rb
-- lib/handler/wrapped_handler.rb
+- lib/handler/reactor_messaging_adapter.rb
 - lib/messenger/messenger.rb
 - lib/messenger/subscription.rb
 - lib/messenger/tracker.rb
 - lib/messenger/tracker_status.rb
 - lib/qpid_proton.rb
-- lib/reactor/acceptor.rb
-- lib/reactor/backoff.rb
-- lib/reactor/connector.rb
 - lib/reactor/container.rb
-- lib/reactor/global_overrides.rb
-- lib/reactor/link_option.rb
-- lib/reactor/reactor.rb
-- lib/reactor/session_per_connection.rb
-- lib/reactor/ssl_config.rb
-- lib/reactor/task.rb
-- lib/reactor/urls.rb
 - lib/types/array.rb
 - lib/types/described.rb
 - lib/types/hash.rb
 - lib/types/strings.rb
-- lib/util/class_wrapper.rb
-- lib/util/condition.rb
-- lib/util/constants.rb
-- lib/util/engine.rb
+- lib/types/type.rb
+- lib/util/deprecation.rb
 - lib/util/error_handler.rb
-- lib/util/handler.rb
-- lib/util/reactor.rb
-- lib/util/swig_helper.rb
 - lib/util/timeout.rb
-- lib/util/uuid.rb
 - lib/util/version.rb
 - lib/util/wrapper.rb
 homepage: http://qpid.apache.org/proton

data/lib/core/base_handler.rb

@@ -1,31 +0,0 @@
-#--
-# 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
-
-  class BaseHandler
-
-    # Override to process unhandled events.
-    #
-    def on_unhandled(method, *args)
-    end
-
-  end
-
-end

data/lib/core/selectable.rb

@@ -1,130 +0,0 @@
-#--
-# 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
-
-  # Selectable enables accessing the underlying file descriptors
-  # for Messenger.
-  #
-  # @private
-  class Selectable
-
-    # @private
-    include Util::SwigHelper
-
-    # @private
-    PROTON_METHOD_PREFIX = "pn_selectable"
-
-    # Returns the underlying file descriptor.
-    #
-    # This can be used in conjunction with the IO class.
-    #
-    def fileno
-      Cproton.pn_selectable_get_fd(@impl)
-    end
-
-    proton_reader :reading, :is_or_get => :is
-
-    proton_reader :writing, :is_or_get => :is
-
-    proton_caller :readable
-
-    proton_caller :writable
-
-    proton_caller :expired
-
-    proton_accessor :registered, :is_or_get => :is
-
-    proton_accessor :terminal, :is_or_get => :is
-
-    proton_caller :terminate
-
-    proton_caller :release
-
-    # @private
-    def self.wrap(impl)
-      return nil if impl.nil?
-
-      self.fetch_instance(impl, :pn_selectable_attachments) || Selectable.new(impl)
-    end
-
-    # @private
-    include Util::Wrapper
-
-    # @private
-    def initialize(impl)
-      @impl = impl
-      self.class.store_instance(self, :pn_selectable_attachments)
-    end
-
-    private
-
-    DEFAULT = Object.new
-
-    public
-
-    def fileno(fd = DEFAULT)
-      if fd == DEFAULT
-        Cproton.pn_selectable_get_fd(@impl)
-      elsif fd.nil?
-        Cproton.pn_selectable_set_fd(@impl, Cproton::PN_INVALID_SOCKET)
-      else
-        Cproton.pn_selectable_set_fd(@impl, fd)
-      end
-    end
-
-    def reading=(reading)
-      if reading.nil?
-        reading = false
-      elsif reading == "0"
-        reading = false
-      else
-        reading = true
-      end
-      Cproton.pn_selectable_set_reading(@impl, reading ? true : false)
-    end
-
-    def writing=(writing)
-      if writing.nil?
-        writing = false
-      elsif writing == "0"
-        writing = false
-      else
-        writing = true
-      end
-      Cproton.pn_selectable_set_writing(@impl, writing ? true : false)
-    end
-
-    def deadline
-      tstamp = Cproton.pn_selectable_get_deadline(@impl)
-      return nil if tstamp.nil?
-      mills_to_sec(tstamp)
-    end
-
-    def deadline=(deadline)
-      Cproton.pn_selectable_set_deadline(sec_to_millis(deadline))
-    end
-
-    def to_io
-      @io ||= IO.new(fileno)
-    end
-
-  end
-
-end