qpid-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mcpie...@apache.org
Subject [33/34] qpid-proton git commit: PROTON-799: Added the Connection class to the Ruby engine APIs.
Date Thu, 14 May 2015 20:24:10 GMT
PROTON-799: Added the Connection 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/9dfef95f
Tree: http://git-wip-us.apache.org/repos/asf/qpid-proton/tree/9dfef95f
Diff: http://git-wip-us.apache.org/repos/asf/qpid-proton/diff/9dfef95f

Branch: refs/heads/ruby-engine-apis
Commit: 9dfef95f89736b82be10f6d212df0385acda333b
Parents: 0aced01
Author: Darryl L. Pierce <mcpierce@gmail.com>
Authored: Fri Jan 16 15:13:04 2015 -0500
Committer: Darryl L. Pierce <mcpierce@gmail.com>
Committed: Thu May 14 15:57:10 2015 -0400

----------------------------------------------------------------------
 proton-c/bindings/ruby/lib/core/connection.rb | 328 +++++++++++++++++++++
 proton-c/bindings/ruby/lib/qpid_proton.rb     |   1 +
 2 files changed, 329 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/9dfef95f/proton-c/bindings/ruby/lib/core/connection.rb
----------------------------------------------------------------------
diff --git a/proton-c/bindings/ruby/lib/core/connection.rb b/proton-c/bindings/ruby/lib/core/connection.rb
new file mode 100644
index 0000000..0a9bf21
--- /dev/null
+++ b/proton-c/bindings/ruby/lib/core/connection.rb
@@ -0,0 +1,328 @@
+#--
+# 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
+
+  # A Connection option has at most one Qpid::Proton::Transport instance.
+  #
+  class Connection < Endpoint
+
+    # @private
+    include Util::SwigHelper
+
+    # @private
+    PROTON_METHOD_PREFIX = "pn_connection"
+
+    # @!attribute hostname
+    #
+    # @return [String] The AMQP hostname for the connection.
+    #
+    proton_accessor :hostname
+
+    # @private
+    proton_reader :attachments
+
+    attr_accessor :overrides
+    attr_accessor :session_policy
+
+    # @private
+    include Util::Wrapper
+
+    # @private
+    def self.wrap(impl)
+      return nil if impl.nil?
+
+      self.fetch_instance(impl, :pn_connection_attachments) || Connection.new(impl)
+    end
+
+    # Constructs a new instance of Connection.
+    #
+    # You do *not* need to provide the underlying C struct, as this is
+    # automatically generated as needed. The argument is a convenience
+    # for returning existing Connection objects.
+    #
+    # @param impl [pn_connection_t] The pn_connection_t struct.
+    #
+    def initialize(impl = Cproton.pn_connection)
+      super()
+      @impl = impl
+      @offered_capabilities = nil
+      @desired_capabilities = nil
+      @properties = nil
+      @overrides = nil
+      @collector = nil
+      @session_policy = nil
+      self.class.store_instance(self, :pn_connection_attachments)
+    end
+
+    def overrides?
+      @dict[:attrs].has_key?(:overrides) && !@dict[:attrs][:overrides].nil?
+    end
+
+    def session_policy?
+      !@session_policy.nil?
+    end
+
+    # This method is used when working within the context of an event.
+    #
+    # @return [Connection] The connection itself.
+    #
+    def connection
+      self
+    end
+
+    # The Transport to which this connection is bound.
+    #
+    # @return [Transport] The transport, or nil if the Connection is unbound.
+    #
+    def transport
+      Transport.wrap(Cproton.pn_connection_transport(@impl))
+    end
+
+    # Associates the connection with an event collector.
+    #
+    # By doing this, key changes in the endpoint's state are reported to
+    # the connector via Event objects that can be inspected and processed.
+    #
+    # Note that, by registering a collector, the user is requesting that an
+    # indefinite number of events be queued up on its behalf. This means
+    # that, unless the application eventual processes these events, the
+    # storage requirements for keeping them will grow without bound. So be
+    # careful and do not register a collector with a connection unless the
+    # application will process the events.
+    #
+    # @param collector [Event::Collector] The event collector.
+    #
+    def collect(collector)
+      if collector.nil?
+        Cproton.pn_connection_collect(@impl, nil)
+      else
+        Cproton.pn_connection_collect(@impl, collector.impl)
+      end
+      @collector = collector
+    end
+
+    # Get the AMQP container name advertised by the remote connection
+    # endpoint.
+    #
+    # This will return nil until the REMOTE_ACTIVE state is reached.
+    #
+    # Any non-nil container returned by this operation will be valid
+    # until the connection is unbound from a transport, or freed,
+    # whichever happens sooner.
+    #
+    # @return [String] The remote connection's AMQP container name.
+    #
+    # @see #container
+    #
+    def remote_container
+      Cproton.pn_connection_remote_container(@impl)
+    end
+
+    def container=(name)
+      Cproton.pn_connection_set_container(@impl, name)
+    end
+
+    def container
+      Cproton.pn_connection_get_container(@impl)
+    end
+
+    # Get the AMQP hostname set by the remote connection endpoint.
+    #
+    # This will return nil until the #REMOTE_ACTIVE state is
+    # reached.
+    #
+    # @return [String] The remote connection's AMQP hostname.
+    #
+    # @see #hostname
+    #
+    def remote_hostname
+      Cproton.pn_connection_remote_hostname(@impl)
+    end
+
+    # Get the AMQP offered capabilities suppolied by the remote connection
+    # endpoint.
+    #
+    # This object returned is valid until the connection is freed. The Data
+    # object will be empty until the remote connection is opened, as
+    # indicated by the #REMOTE_ACTIVE flag.
+    #
+    # @return [Data] The offered capabilities.
+    #
+    def remote_offered_capabilities
+      data_to_object(Cproton.pn_connection_remote_offered_capabilities(@impl))
+    end
+
+    # Get the AMQP desired capabilities supplied by the remote connection
+    # endpoint.
+    #
+    # The object returned is valid until the connection is freed. The Data
+    # object will be empty until the remote connection is opened, as
+    # indicated by the #REMOTE_ACTIVE flag.
+    #
+    # @return [Data] The desired capabilities.
+    #
+    def remote_desired_capabilities
+      data_to_object(Cproton.pn_connection_remote_desired_capabilities(@impl))
+    end
+
+    # Get the AMQP connection properties supplie by the remote connection
+    # endpoint.
+    #
+    # The object returned is valid until the connection is freed. The Data
+    # object will be empty until the remote connection is opened, as
+    # indicated by the #REMOTE_ACTIVE flag.
+    #
+    # @return [Data] The remote properties.
+    #
+    def remote_properties
+      data_to_object(Cproton.pn_connection_remote_properites(@impl))
+    end
+
+    # Opens the connection.
+    #
+    def open
+      object_to_data(@offered_capabilities,
+                     Cproton.pn_connection_offered_capabilities(@impl))
+      object_to_data(@desired_capabilities,
+                     Cproton.pn_connection_desired_capabilities(@impl))
+      object_to_data(@properties,
+                     Cproton.pn_connection_properties(@impl))
+      Cproton.pn_connection_open(@impl)
+    end
+
+    # Closes the connection.
+    #
+    # Once this operation has completed, the #LOCAL_CLOSED state flag will be
+    # set.
+    #
+    def close
+      self._update_condition
+      Cproton.pn_connection_close(@impl)
+    end
+
+    # Gets the endpoint current state flags
+    #
+    # @see Endpoint#LOCAL_UNINIT
+    # @see Endpoint#LOCAL_ACTIVE
+    # @see Endpoint#LOCAL_CLOSED
+    # @see Endpoint#LOCAL_MASK
+    #
+    # @return [Fixnum] The state flags.
+    #
+    def state
+      Cproton.pn_connection_state(@impl)
+    end
+
+    # Returns the session for this connection.
+    #
+    # @return [Session] The session.
+    #
+    def session
+      @session ||= Session.wrap(Cproton.pn_session(@impl))
+    end
+
+    # Returns the first session from the connection that matches the specified
+    # state mask.
+    #
+    # Examines the state of each session owned by the connection, and returns
+    # the first session that matches the given state mask. If the state mask
+    # contains *both* local and remote flags, then an exact match against
+    # those flags is performed. If the state mask contains only local *or*
+    # remote flags, then a match occurs if a*any* of the local or remote flags
+    # are set, respectively.
+    #
+    # @param mask [Fixnum] The state mask to be matched.
+    #
+    # @return [Session] The first matching session, or nil if none matched.
+    #
+    # @see Endpoint#LOCAL_UNINIT
+    # @see Endpoint#LOCAL_ACTIVE
+    # @see Endpoint#LOCAL_CLOSED
+    # @see Endpoint#REMOTE_UNINIT
+    # @see Endpoint#REMOTE_ACTIVE
+    # @see Endpoint#REMOTE_CLOSED
+    #
+    def session_head(mask)
+      Session.wrap(Cproton.pn_session_header(@impl, mask))
+    end
+
+    # Returns the first link that matches the given state mask.
+    #
+    # Examines the state of each link owned by the connection and returns the
+    # first that matches the given state mask. If the state mask contains
+    # *both* local and remote flags, then an exact match against those flags
+    # is performed. If the state mask contains *only* local or remote flags,
+    # then a match occurs if *any* of the local ore remote flags are set,
+    # respectively.
+    #
+    # @param mask [Fixnum] The state mask to be matched.
+    #
+    # @return [Link] The first matching link, or nil if none matched.
+    #
+    # @see Endpoint#LOCAL_UNINIT
+    # @see Endpoint#LOCAL_ACTIVE
+    # @see Endpoint#LOCAL_CLOSED
+    # @see Endpoint#REMOTE_UNINIT
+    # @see Endpoint#REMOTE_ACTIVE
+    # @see Endpoint#REMOTE_CLOSED
+    #
+    def link_head(mask)
+      Link.wrap(Cproton.pn_link_head(@impl, mask))
+    end
+
+    # Extracts the first delivery on the connection that has pending
+    # operations.
+    #
+    # A readable delivery indicates message data is waiting to be read. A
+    # A writable delivery indcates that message data may be sent. An updated
+    # delivery indicates that the delivery's disposition has changed.
+    #
+    # A delivery will never be *both* readable and writable, but it may be
+    # both readable or writable and updated.
+    #
+    # @return [Delivery] The delivery, or nil if none are available.
+    #
+    # @see Delivery#next
+    #
+    def work_head
+      Delivery.wrap(Cproton.pn_work_head(@impl))
+    end
+
+    # Returns the code for a connection error.
+    #
+    # @return [Fixnum] The error code.
+    #
+    def error
+      Cproton.pn_error_code(Cproton.pn_connection_error(@impl))
+    end
+
+    # @private
+    def _local_condition
+      Cproton.pn_connection_condition(@impl)
+    end
+
+    # @private
+    def _remote_condition
+      Cproton.pn_connection_remote_condition(@impl)
+    end
+
+  end
+
+end

http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/9dfef95f/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 ed8532f..2a57b32 100644
--- a/proton-c/bindings/ruby/lib/qpid_proton.rb
+++ b/proton-c/bindings/ruby/lib/qpid_proton.rb
@@ -62,6 +62,7 @@ require "core/delivery"
 require "core/link"
 require "core/sender"
 require "core/receiver"
+require "core/connection"
 
 # 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


Mime
View raw message