qpid_proton 0.17.0 → 0.18.0

data/lib/core/message.rb

@@ -129,13 +129,13 @@ module Qpid::Proton
     end
 
     # Creates a new +Message+ instance.
-    def initialize
+    def initialize(body = nil)
       @impl = Cproton.pn_message
       ObjectSpace.define_finalizer(self, self.class.finalize!(@impl))
       @properties = {}
       @instructions = {}
       @annotations = {}
-      @body = nil
+      self.body = body unless body.nil?
     end
 
     def to_s
@@ -224,7 +224,7 @@ module Qpid::Proton
     # * priority - the priority value
     #
     def priority=(priority)
-      raise TypeError.new("invalid priority: #{priority}") if priority.nil? || !([Float, Fixnum].include?(priority.class))
+      raise TypeError.new("invalid priority: #{priority}") if not priority.is_a?(Numeric)
       raise RangeError.new("priority out of range: #{priority}") if ((priority > 255) || (priority < 0))
       Cproton.pn_message_set_priority(@impl, priority.floor)
     end
@@ -242,8 +242,8 @@ module Qpid::Proton
     # * time - the time in milliseconds
     #
     def ttl=(time)
-      raise TypeError.new("invalid ttl: #{time}") if time.nil? || !([Float, Fixnum].include?(time.class))
-      raise RangeError.new("time out of range: #{time}") if ((time < 0))
+      raise TypeError.new("invalid ttl: #{time}") if not time.is_a?(Numeric)
+      raise RangeError.new("ttl out of range: #{time}") if ((time.to_i < 0))
       Cproton.pn_message_set_ttl(@impl, time.floor)
     end
 
@@ -275,9 +275,8 @@ module Qpid::Proton
     # * count - the delivery count
     #
     def delivery_count=(count)
-      raise ::ArgumentError.new("invalid count: #{count}") if count.nil? || !([Float, Fixnum].include?(count.class))
+      raise ::ArgumentError.new("invalid count: #{count}") if not count.is_a?(Numeric)
       raise RangeError.new("count out of range: #{count}") if count < 0
-
       Cproton.pn_message_set_delivery_count(@impl, count.floor)
     end
 
@@ -408,24 +407,12 @@ module Qpid::Proton
       Cproton.pn_message_get_content_type(@impl)
     end
 
-    # Sets the message content.
-    #
-    # *WARNING:* This method has been deprecated. Please use #body= instead to
-    # set the content of a message.
-    #
-    # ==== Options
-    #
-    # * content - the content
-    #
+    # @deprecated use {#body=}
     def content=(content)
       Cproton.pn_message_load(@impl, content)
     end
 
-    # Returns the message content.
-    #
-    # *WARNING:* This method has been deprecated. Please use #body instead to
-    # retrieve the content of a message.
-    #
+    # @deprecated use {#body}
     def content
       size = 16
       loop do

data/lib/core/receiver.rb

@@ -58,7 +58,7 @@ module Qpid::Proton
 
     # Grants credit for incoming deliveries.
     #
-    # @param n [Fixnum] The amount to increment the link credit.
+    # @param n [Integer] The amount to increment the link credit.
     #
     def flow(n)
       Cproton.pn_link_flow(@impl, n)
@@ -74,9 +74,9 @@ module Qpid::Proton
     # #receive until nil is returned, or verify that #partial? is false and
     # Delivery#pending is 0.
     #
-    # @param limit [Fixnum] The maximum bytes to receive.
+    # @param limit [Integer] The maximum bytes to receive.
     #
-    # @return [Fixnum, nil] The number of bytes received, or nil if the end of
+    # @return [Integer, nil] The number of bytes received, or nil if the end of
     # the stream was reached.t
     #
     # @see Deliver#pending To see how much buffer space is needed.

data/lib/core/sasl.rb

@@ -28,19 +28,7 @@ module Qpid::Proton
   # The peer acting as the SASL server must provide authentication against the
   # received credentials.
   #
-  # @example
-  #   # SCENARIO: the remote endpoint has not initialized their connection
-  #   #           then the local endpoint, acting as a SASL server, decides
-  #   #           to allow an anonymous connection.
-  #   #
-  #   #           The SASL layer locally assumes the role of server and then
-  #   #           enables anonymous authentication for the remote endpoint.
-  #   #
-  #   sasl = @transport.sasl
-  #   sasl.server
-  #   sasl.mechanisms("ANONYMOUS")
-  #   sasl.done(Qpid::Proton::SASL::OK)
-  #
+  # @note Do not instantiate directly, use {Transport#sasl} to create a SASL object.
   class SASL
 
     # Negotation has not completed.
@@ -50,45 +38,89 @@ module Qpid::Proton
     # Authentication failed due to bad credentials.
     AUTH = Cproton::PN_SASL_AUTH
 
-    # Constructs a new instance for the given transport.
-    #
-    # @param transport [Transport] The transport.
-    #
-    # @private A SASL should be fetched only from its Transport
-    #
+    private
+
+    include Util::SwigHelper
+    PROTON_METHOD_PREFIX = "pn_sasl"
+
+    public
+
+    # @private
+    # @note Do not instantiate directly, use {Transport#sasl} to create a SASL object.
     def initialize(transport)
       @impl = Cproton.pn_sasl(transport.impl)
     end
 
-    # Sets the acceptable SASL mechanisms.
+    # @!attribute allow_insecure_mechs
+    #   @return [Bool] true if clear text authentication is allowed on insecure connections.
+    proton_accessor :allow_insecure_mechs
+
+    # @!attribute user [r]
+    #   @return [String] the authenticated user name
+    proton_reader :user
+
+    # Set the mechanisms allowed for SASL negotation
+    # @param mechanisms [String] space-delimited list of allowed mechanisms
+    def allowed_mechs=(mechanisms)
+      Cproton.pn_sasl_allowed_mechs(@impl, mechanisms)
+    end
+
+    # @deprecated use {#allowed_mechs=}
+    def mechanisms(m)
+      self.allowed_mechs = m
+    end
+
+    # True if extended SASL negotiation is supported
     #
-    # @param mechanisms [String] The space-delimited set of mechanisms.
+    # All implementations of Proton support ANONYMOUS and EXTERNAL on both
+    # client and server sides and PLAIN on the client side.
     #
-    # @example Use anonymous SASL authentication.
-    #  @sasl.mechanisms("GSSAPI CRAM-MD5 PLAIN")
+    # Extended SASL implememtations use an external library (Cyrus SASL)
+    # to support other mechanisms.
     #
-    def mechanisms(mechanisms)
-      Cproton.pn_sasl_mechanisms(@impl, mechanisms)
+    # @return [Bool] true if extended SASL negotiation is supported
+    def self.extended?()
+      Cproton.pn_sasl_extended()
     end
 
-    # Returns the outcome of the SASL negotiation.
+    # Set the sasl configuration path
+    #
+    # This is used to tell SASL where to look for the configuration file.
+    # In the current implementation it can be a colon separated list of directories.
+    #
+    # The environment variable PN_SASL_CONFIG_PATH can also be used to set this path,
+    # but if both methods are used then this pn_sasl_config_path() will take precedence.
+    #
+    # If not set the underlying implementation default will be used.
     #
-    # @return [Fixnum] The outcome.
+    # @param path the configuration path
     #
-    def outcome
-      outcome = Cprotn.pn_sasl_outcome(@impl)
-      return nil if outcome == NONE
-      outcome
+    def self.config_path=(path)
+      Cproton.pn_sasl_config_path(nil, path)
+      path
     end
 
-    # Set the condition of the SASL negotiation.
+    # @deprecated use {config_path=}
+    def self.config_path(path)
+      self.config_path = path
+    end
+
+    # Set the configuration file name, without extension
+    #
+    # The name with an a ".conf" extension will be searched for in the
+    # configuration path.  If not set, it defaults to "proton-server" or
+    # "proton-client" for a server (incoming) or client (outgoing) connection
+    # respectively.
     #
-    # @param outcome [Fixnum] The outcome.
+    # @param name the configuration file name without extension
     #
-    def done(outcome)
-      Cproton.pn_sasl_done(@impl, outcome)
+    def self.config_name=(name)
+      Cproton.pn_sasl_config_name(nil, name)
     end
 
+    # @deprecated use {config_name=}
+    def self.config_name(name)
+      self.config_name = name
+    end
   end
-
 end

data/lib/core/sender.rb

@@ -33,7 +33,7 @@ module Qpid::Proton
 
     # Signals the availability of deliveries.
     #
-    # @param n [Fixnum] The number of deliveries potentially available.
+    # @param n [Integer] The number of deliveries potentially available.
     #
     def offered(n)
       Cproton.pn_link_offered(@impl, n)
@@ -44,7 +44,7 @@ module Qpid::Proton
     # @param object [Object] The content to send.
     # @param tag [Object] The tag
     #
-    # @return [Fixnum] The number of bytes sent.
+    # @return [Integer] The number of bytes sent.
     #
     def send(object, tag = nil)
       if object.respond_to? :proton_send
@@ -58,7 +58,7 @@ module Qpid::Proton
     #
     # @param bytes [Array] The bytes to send.
     #
-    # @return n [Fixnum] The number of bytes sent.
+    # @return [Integer] The number of bytes sent.
     #
     def stream(bytes)
       Cproton.pn_link_send(@impl, bytes)

data/lib/core/session.rb

@@ -41,7 +41,7 @@ module Qpid::Proton
     # negotatied frame size of the transport, it will be rounded up to one full
     # frame.
     #
-    # @return [Fixnum] The incoing capacity of the session, measured in bytes.
+    # @return [Integer] The incoing capacity of the session, measured in bytes.
     #
     proton_accessor :incoming_capacity
 
@@ -50,13 +50,13 @@ module Qpid::Proton
 
     # @!attribute [r] outgoing_bytes
     #
-    # @return [Fixnum] The number of outgoing bytes currently being buffered.
+    # @return [Integer] The number of outgoing bytes currently being buffered.
     #
     proton_caller :outgoing_bytes
 
     # @!attribute [r] incoming_bytes
     #
-    # @return [Fixnum] The number of incomign bytes currently being buffered.
+    # @return [Integer] The number of incomign bytes currently being buffered.
     #
     proton_caller :incoming_bytes
 
@@ -71,7 +71,7 @@ module Qpid::Proton
 
     # @!attribute [r] state
     #
-    # @return [Fixnum] The endpoint state.
+    # @return [Integer] The endpoint state.
     #
     proton_caller :state
 
@@ -104,7 +104,7 @@ module Qpid::Proton
     # 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 [Fixnum] The state mask to match.
+    # @param state_mask [Integer] The state mask to match.
     #
     # @return [Session, nil] The next session if one matches, or nil.
     #

data/lib/core/ssl_domain.rb

@@ -123,7 +123,7 @@ module Qpid::Proton
     # call returns. SSL instances created before invoking this method will use
     # the domain's previous setting.
     #
-    # @param verify_mode [Fixnum] The level of validation to apply to the peer.
+    # @param verify_mode [Integer] The level of validation to apply to the peer.
     # @param trusted_CAs [String] The path to a database of trusted CAs that
     #   the server will advertise to the peer client if the server has been
     #   configured to verify its peer.

data/lib/core/terminus.rb

@@ -73,7 +73,7 @@ module Qpid::Proton
 
     # @!attribute type
     #
-    # @return [Fixnum] The terminus type.
+    # @return [Integer] The terminus type.
     #
     # @see SOURCE
     # @see TARGET
@@ -89,7 +89,7 @@ module Qpid::Proton
 
     # @!attribute durability
     #
-    # @return [Fixnum] The durability mode of the terminus.
+    # @return [Integer] The durability mode of the terminus.
     #
     # @see NONDURABLE
     # @see CONFIGURATION
@@ -99,7 +99,7 @@ module Qpid::Proton
 
     # @!attribute expiry_policy
     #
-    # @return [Fixnum] The expiry policy.
+    # @return [Integer] The expiry policy.
     #
     # @see EXPIRE_WITH_LINK
     # @see EXPIRE_WITH_SESSION
@@ -110,7 +110,7 @@ module Qpid::Proton
 
     # @!attribute timeout
     #
-    # @return [Fixnum] The timeout period.
+    # @return [Integer] The timeout period.
     #
     proton_accessor :timeout
 
@@ -122,7 +122,7 @@ module Qpid::Proton
 
     # @!attribute distribution_mode
     #
-    # @return [Fixnum] The distribution mode.
+    # @return [Integer] The distribution mode.
     #
     # @see DIST_MODE_UNSPECIFIED
     # @see DIST_MODE_COPY

data/lib/core/transport.rb

@@ -89,37 +89,37 @@ module Qpid::Proton
 
     # @!attribute channel_max
     #
-    # @return [Fixnum] The maximum allowed channel.
+    # @return [Integer] The maximum allowed channel.
     #
     proton_accessor :channel_max
 
     # @!attribute [r] remote_channel_max
     #
-    # @return [Fixnum] The maximum allowed channel of a transport's remote peer.
+    # @return [Integer] The maximum allowed channel of a transport's remote peer.
     #
     proton_caller :remote_channel_max
 
     # @!attribute max_frame_size
     #
-    # @return [Fixnum] The maximum frame size.
+    # @return [Integer] The maximum frame size.
     #
     proton_accessor :max_frame_size
 
     # @!attribute [r] remote_max_frame_size
     #
-    # @return [Fixnum] The maximum frame size of the transport's remote peer.
+    # @return [Integer] The maximum frame size of the transport's remote peer.
     #
     proton_reader :remote_max_frame_size
 
     # @!attribute idle_timeout
     #
-    # @return [Fixnum] The idle timeout.
+    # @return [Integer] The idle timeout.
     #
     proton_accessor :idle_timeout
 
     # @!attribute [r] remote_idle_timeout
     #
-    # @return [Fixnum] The idle timeout for the transport's remote peer.
+    # @return [Integer] The idle timeout for the transport's remote peer.
     #
     proton_accessor :remote_idle_timeout
 
@@ -135,7 +135,7 @@ module Qpid::Proton
     # Calls to #process may alter the value of this value. See #process for
     # more details
     #
-    # @return [Fixnum] The amount of free space for input following the
+    # @return [Integer] The amount of free space for input following the
     # transport's tail pointer.
     #
     proton_caller :capacity
@@ -170,7 +170,7 @@ module Qpid::Proton
     #
     # Calls to #pop may alter the value of this pointer as well.
     #
-    # @return [Fixnum] The number of pending output bytes following the header
+    # @return [Integer] The number of pending output bytes following the header
     # pointer.
     #
     # @raise [TransportError] If any error other than an end of stream occurs.
@@ -188,13 +188,13 @@ module Qpid::Proton
 
     # @!attribute [r] frames_output
     #
-    # @return [Fixnum] The number of frames output by a transport.
+    # @return [Integer] The number of frames output by a transport.
     #
     proton_reader :frames_output
 
     # @!attribute [r] frames_input
     #
-    # @return [Fixnum] The number of frames input by a transport.
+    # @return [Integer] The number of frames input by a transport.
     #
     proton_reader :frames_input
 
@@ -218,7 +218,7 @@ module Qpid::Proton
 
     # Creates a new transport instance.
     #
-    # @param mode [Fixnum] The transport mode, either CLIENT or SERVER
+    # @param mode [Integer] The transport mode, either CLIENT or SERVER
     # @param impl [pn_transport_t] Should not be used.
     #
     # @raise [TransportError] If the mode is invalid.
@@ -268,7 +268,7 @@ module Qpid::Proton
 
     # Updates the transports trace flags.
     #
-    # @param level [Fixnum] The trace level.
+    # @param level [Integer] The trace level.
     #
     # @see TRACE_OFF
     # @see TRACE_RAW
@@ -302,7 +302,7 @@ module Qpid::Proton
     #
     # @param data [String] The bytes to be pushed.
     #
-    # @return [Fixnum] The number of bytes pushed.
+    # @return [Integer] The number of bytes pushed.
     #
     def push(data)
       Cproton.pn_transport_push(@impl, data, data.length)
@@ -315,7 +315,7 @@ module Qpid::Proton
     # pointer. It may also change the value for #tail, as well as the amount of
     # free space reported by #capacity.
     #
-    # @param size [Fixnum] The number of bytes to process.
+    # @param size [Integer] The number of bytes to process.
     #
     # @raise [TransportError] If an error occurs.
     #
@@ -335,7 +335,7 @@ module Qpid::Proton
 
     # Returns the specified number of bytes from the transport's buffers.
     #
-    # @param size [Fixnum] The number of bytes to return.
+    # @param size [Integer] The number of bytes to return.
     #
     # @return [String] The data peeked.
     #
@@ -351,7 +351,7 @@ module Qpid::Proton
     # Removes the specified number of bytes from the pending output queue
     # following the transport's head pointer.
     #
-    # @param size [Fixnum] The number of bytes to remove.
+    # @param size [Integer] The number of bytes to remove.
     #
     def pop(size)
       Cproton.pn_transport_pop(@impl, size)
@@ -378,7 +378,7 @@ module Qpid::Proton
     #
     # @param now [Time] The timestamp.
     #
-    # @return [Fixnum] If non-zero, the expiration time of the next pending
+    # @return [Integer] If non-zero, the expiration time of the next pending
     #   timer event for the transport. The caller must invoke #tick again at
     #   least once at or before this deadline occurs.
     #
@@ -386,6 +386,8 @@ module Qpid::Proton
       Cproton.pn_transport_tick(@impl, now)
     end
 
+    # Create, or return existing, SSL object for the transport.
+    # @return [SASL] the SASL object
     def sasl
       SASL.new(self)
     end