qpid_proton 0.18.1 → 0.19.0

data/lib/core/session.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
 
@@ -24,15 +23,12 @@ module Qpid::Proton
   # A Session has a single parent Qpid::Proton::Connection instance.
   #
   class Session < Endpoint
-
-    # @private
-    include Util::Wrapper
-
-    # @private
-    include Util::SwigHelper
+    include Util::Deprecation
 
     # @private
     PROTON_METHOD_PREFIX = "pn_session"
+    # @private
+    include Util::Wrapper
 
     # @!attribute incoming_capacity
     #
@@ -43,10 +39,10 @@ module Qpid::Proton
     #
     # @return [Integer] The incoing capacity of the session, measured in bytes.
     #
-    proton_accessor :incoming_capacity
+    proton_set_get :incoming_capacity
 
     # @private
-    proton_reader :attachments
+    proton_get :attachments
 
     # @!attribute [r] outgoing_bytes
     #
@@ -60,13 +56,7 @@ module Qpid::Proton
     #
     proton_caller :incoming_bytes
 
-    # @!method open
-    # Opens the session.
-    #
-    # Once this operaton has completed, the state flag is updated.
-    #
-    # @see LOCAL_ACTIVE
-    #
+    # Open the session
     proton_caller :open
 
     # @!attribute [r] state
@@ -87,28 +77,16 @@ module Qpid::Proton
       self.class.store_instance(self, :pn_session_attachments)
     end
 
-    # Closed the session.
-    #
-    # Once this operation has completed, the state flag will be set. This may be
-    # called without calling #open, in which case it is the equivalence of
-    # calling #open and then close immediately.
-    #
-    def close
-      self._update_condition
+    # Close the local end of the session. The remote end may or may not be closed.
+    # @param error [Condition] Optional error condition to send with the close.
+    def close(error=nil)
+      Condition.assign(_local_condition, error)
       Cproton.pn_session_close(@impl)
     end
 
-    # Retrieves the next session from a given connection that matches the
-    # specified state mask.
-    #
-    # When uses with Connection#session_head an application can access all of
-    # the session son the connection that match the given state.
-    #
-    # @param state_mask [Integer] The state mask to match.
-    #
-    # @return [Session, nil] The next session if one matches, or nil.
-    #
+    # @deprecated use {Connection#each_session}
     def next(state_mask)
+      deprecated __method__, "Connection#each_session"
       Session.wrap(Cproton.pn_session_next(@impl, state_mask))
     end
 
@@ -120,40 +98,62 @@ module Qpid::Proton
       Connection.wrap(Cproton.pn_session_connection(@impl))
     end
 
-    # Constructs a new sender.
-    #
-    # Each sender between two AMQP containers must be uniquely named. Note that
-    # this uniqueness cannot be enforced at the library level, so some
-    # consideration should be taken in choosing link names.
-    #
-    # @param name [String] The link name.
-    #
-    # @return [Sender, nil] The sender, or nil if an error occurred.
-    #
+    # @deprecated use {#open_sender}
     def sender(name)
-      Sender.new(Cproton.pn_sender(@impl, name))
+      deprecated __method__, "open_sender"
+      Sender.new(Cproton.pn_sender(@impl, name));
     end
 
-    # Constructs a new receiver.
-    #
-    # Each receiver between two AMQP containers must be uniquely named. Note
-    # that this uniqueness cannot be enforced at the library level, so some
-    # consideration should be taken in choosing link names.
-    #
-    # @param name [String] The link name.
-    #
-    # @return [Receiver, nil] The receiver, or nil if an error occurred.
-    #
+    # @deprecated use {#open_receiver}
     def receiver(name)
+      deprecated __method__, "open_receiver"
       Receiver.new(Cproton.pn_receiver(@impl, name))
     end
 
-    # @private
+    # Create and open a {Receiver} link, see {Receiver#open}
+    # @param opts [Hash] receiver options, see {Receiver#open}
+    # @return [Receiver]
+    def open_receiver(opts=nil) 
+      name = opts[:name] rescue connection.link_name
+      Receiver.new(Cproton.pn_receiver(@impl, name)).open(opts)
+    end
+
+    # Create and open a {Sender} link, see {#open}
+    # @param opts [Hash] sender options, see {Sender#open}
+    # @return [Sender]
+    def open_sender(opts=nil)
+      name = opts[:name] rescue connection.link_name
+      Sender.new(Cproton.pn_sender(@impl, name)).open(opts)
+    end
+
+    # Get the links on this Session.
+    # @overload each_link
+    #   @yieldparam l [Link] pass each link to block
+    # @overload each_link
+    #   @return [Enumerator] enumerator over links
+    def each_link
+      return enum_for(:each_link) unless block_given?
+      l = Cproton.pn_link_head(Cproton.pn_session_connection(@impl), 0);
+      while l
+        link = Link.wrap(l)
+        yield link if link.session == self
+        l = Cproton.pn_link_next(l, 0)
+      end
+      self
+    end
+
+    # Get the {Sender} links - see {#each_link}
+    def each_sender() each_link.select { |l| l.sender? }; end
+
+    # Get the {Receiver} links - see {#each_link}
+    def each_receiver() each_link.select { |l| l.receiver? }; end
+
+    private
+
     def _local_condition
       Cproton.pn_session_condition(@impl)
     end
 
-    # @private
     def _remote_condition # :nodoc:
       Cproton.pn_session_remote_condition(@impl)
     end

data/lib/core/ssl.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
 
@@ -52,7 +51,7 @@ module Qpid::Proton
   # @see #resume_status
   #
   class SSL
-
+ 
     # Session resume state is unkonnwn or not supported.
     RESUME_UNKNOWN = Cproton::PN_SSL_RESUME_UNKNOWN
     # Session renegotiated and not resumed.
@@ -60,17 +59,13 @@ module Qpid::Proton
     # Session resumed from the previous session.
     RESUME_REUSED = Cproton::PN_SSL_RESUME_REUSED
 
-    # @private
-    include Util::SwigHelper
-
     # @private
     PROTON_METHOD_PREFIX = "pn_ssl"
-
+    # @private
+    include Util::Wrapper
     # @private
     include Util::ErrorHandler
 
-    can_raise_error :peer_hostname=, :error_class => SSLError
-
     # Returns whether SSL is supported.
     #
     # @return [Boolean] True if SSL support is available.
@@ -133,8 +128,7 @@ module Qpid::Proton
     #
     def protocol_name
       rc, name = Cproton.pn_ssl_get_protocol_name(@impl, 128)
-      retur name if rc
-      nil
+      name if rc
     end
 
     # Checks whether or not the state has resumed.
@@ -158,7 +152,5 @@ module Qpid::Proton
       raise SSLError.new if error < 0
       return name
     end
-
   end
-
 end

data/lib/core/ssl_details.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
 

data/lib/core/ssl_domain.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
 
@@ -43,11 +42,6 @@ module Qpid::Proton
     # @private
     include Util::ErrorHandler
 
-    can_raise_error :credentials, :error_class => Qpid::Proton::SSLError
-    can_raise_error :trusted_ca_db, :error_class => Qpid::Proton::SSLError
-    can_raise_error :peer_authentication, :error_class => Qpid::Proton::SSLError
-    can_raise_error :allow_unsecured_client, :error_class => Qpid::Proton::SSLError
-
     # @private
     attr_reader :impl
 
@@ -151,6 +145,9 @@ module Qpid::Proton
       Cproton.pn_ssl_domain_allow_unsecured_client(@impl);
     end
 
+    can_raise_error :credentials, :error_class => Qpid::Proton::SSLError
+    can_raise_error :trusted_ca_db, :error_class => Qpid::Proton::SSLError
+    can_raise_error :peer_authentication, :error_class => Qpid::Proton::SSLError
+    can_raise_error :allow_unsecured_client, :error_class => Qpid::Proton::SSLError
   end
-
 end

data/lib/core/terminus.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
 
@@ -30,6 +29,7 @@ module Qpid::Proton
   # the Link.
   #
   class Terminus
+    include Util::Deprecation
 
     # Indicates a non-existent source or target terminus.
     UNSPECIFIED = Cproton::PN_UNSPECIFIED
@@ -65,11 +65,10 @@ module Qpid::Proton
     # The receives compete for messages.
     DIST_MODE_MOVE = Cproton::PN_DIST_MODE_MOVE
 
-    # @private
-    include Util::SwigHelper
-
     # @private
     PROTON_METHOD_PREFIX = "pn_terminus"
+    # @private
+    include Util::Wrapper
 
     # @!attribute type
     #
@@ -79,15 +78,15 @@ module Qpid::Proton
     # @see TARGET
     # @see COORDINATOR
     #
-    proton_accessor :type
+    proton_set_get :type
 
     # @!attribute address
     #
     # @return [String] The terminus address.
     #
-    proton_accessor :address
+    proton_set_get :address
 
-    # @!attribute durability
+    # @!attribute durability_mode
     #
     # @return [Integer] The durability mode of the terminus.
     #
@@ -95,7 +94,11 @@ module Qpid::Proton
     # @see CONFIGURATION
     # @see DELIVERIES
     #
-    proton_accessor :durability
+    proton_forward :durability_mode, :get_durability
+    proton_forward :durability_mode=, :set_durability
+
+    deprecated_alias :durability, :durability_mode
+    deprecated_alias :durability=, :durability_mode=
 
     # @!attribute expiry_policy
     #
@@ -106,37 +109,33 @@ module Qpid::Proton
     # @see EXPIRE_WITH_CONNECTION
     # @see EXPIRE_NEVER
     #
-    proton_accessor :expiry_policy
+    proton_set_get :expiry_policy
 
     # @!attribute timeout
     #
     # @return [Integer] The timeout period.
     #
-    proton_accessor :timeout
+    proton_set_get :timeout
 
     # @!attribute dynamic?
     #
     # @return [Boolean] True if the terminus is dynamic.
     #
-    proton_accessor :dynamic, :is_or_get => :is
+    proton_set_is :dynamic
 
     # @!attribute distribution_mode
     #
-    # @return [Integer] The distribution mode.
+    # @return [Integer] The distribution mode. Only relevant for a message source.
     #
     # @see DIST_MODE_UNSPECIFIED
     # @see DIST_MODE_COPY
     # @see DIST_MODE_MOVE
     #
-    proton_accessor :distribution_mode
+    proton_set_get :distribution_mode
 
     # @private
     include Util::ErrorHandler
 
-    can_raise_error [:type=, :address=, :durability=, :expiry_policy=,
-                          :timeout=, :dynamic=, :distribution_mode=, :copy],
-                    :error_class => Qpid::Proton::LinkError
-
     # @private
     attr_reader :impl
 
@@ -157,7 +156,7 @@ module Qpid::Proton
     # @return [Data] The terminus properties.
     #
     def properties
-      Data.new(Cproton.pn_terminus_properties(@impl))
+      Codec::Data.new(Cproton.pn_terminus_properties(@impl))
     end
 
     # Access and modify the AMQP capabilities data for the Terminus.
@@ -172,7 +171,7 @@ module Qpid::Proton
     # @return [Data] The terminus capabilities.
     #
     def capabilities
-      Data.new(Cproton.pn_terminus_capabilities(@impl))
+      Codec::Data.new(Cproton.pn_terminus_capabilities(@impl))
     end
 
     # Access and modify the AMQP outcomes for the Terminus.
@@ -187,10 +186,11 @@ module Qpid::Proton
     # @return [Data] The terminus outcomes.
     #
     def outcomes
-      Data.new(Cproton.pn_terminus_outcomes(@impl))
+      Codec::Data.new(Cproton.pn_terminus_outcomes(@impl))
     end
 
-    # Access and modify the AMQP filter set for the Terminus.
+    # Access and modify the AMQP filter set for a source terminus.
+    # Only relevant for a message source.
     #
     # This operation will return an instance of Data that is valid until the
     # Terminus is freed due to its parent being freed. Any data contained in
@@ -202,17 +202,49 @@ module Qpid::Proton
     # @return [Data] The terminus filter.
     #
     def filter
-      Data.new(Cproton.pn_terminus_filter(@impl))
+      Codec::Data.new(Cproton.pn_terminus_filter(@impl))
     end
 
-    # Copy another Terminus into this instance.
-    #
-    # @param source [Terminus] The source instance.
-    #
-    def copy(source)
-      Cproton.pn_terminus_copy(@impl,source.impl)
+    # Replace the data in this Terminus with the contents of +other+
+    # @param other [Terminus] The other instance.
+    def replace(other)
+      Cproton.pn_terminus_copy(@impl, other.impl)
+      self
+    end
+    deprecated_alias :copy, :replace
+
+    # Apply options to this terminus.
+    # @option opts [String] :address the node address
+    # @option opts [Boolean] :dynamic (false)
+    #   if true, request a new node with a unique address to be created. +:address+ is ignored.
+    # @option opts [Integer] :distribution_mode see {#distribution_mode}, only for source nodes
+    # @option opts [Integer] :durability_mode see {#durability_mode}
+    # @option opts [Integer] :timeout see {#timeout}
+    # @option opts [Integer] :expiry_policy see {#expiry_policy}
+    # @option opts [Hash] :filter see {#filter}, only for source nodes
+    # @option opts [Hash] :capabilities see {#capabilities}
+    def apply(opts=nil)
+      return unless opts
+      if opts.is_a? String      # Shorthand for address
+        self.address = opts
+      else
+        opts.each_pair do |k,v|
+          case k
+          when :address then self.address = v
+          when :dynamic then self.dynamic = !!v
+          when :distribution_mode then self.distribution_mode = v
+          when :durability_mode then self.durability_mode = v
+          when :timeout then self.timeout = v
+          when :expiry_policy then self.expiry_policy = v
+          when :filter then self.filter = v
+          when :capabilities then self.capabilities = v
+          end
+        end
+      end
     end
 
+    can_raise_error([:type=, :address=, :durability=, :expiry_policy=,
+                     :timeout=, :dynamic=, :distribution_mode=, :copy],
+                    :error_class => Qpid::Proton::LinkError)
   end
-
 end