stomp 1.4.3 → 1.4.4

data/lib/connection/utils.rb

@@ -11,7 +11,7 @@ module Stomp
 
     private
 
-    # Support multi-homed servers.  
+    # Support multi-homed servers.
     def _expand_hosts(hash)
       new_hash = hash.clone
       new_hash[:hosts_cloned] = hash[:hosts].clone
@@ -137,8 +137,16 @@ module Stomp
             rescue Exception => aex
               raise if aex.is_a?(Stomp::Error::LoggerConnectionError)
             end
-
-            raise Stomp::Error::MaxReconnectAttempts if max_reconnect_attempts?
+            if max_reconnect_attempts?
+              $stderr.print "In socket() Reached MaxReconnectAttempts"
+              ### _dump_threads()
+              mt = @parameters[:client_main]
+              if !mt.nil?
+                mt.raise Stomp::Error::MaxReconnectAttempts
+                Thread::exit
+              end
+              raise Stomp::Error::MaxReconnectAttempts
+            end
             sleep(@reconnect_delay)
             @connection_attempts += 1
 
@@ -236,11 +244,14 @@ module Stomp
     # __old_receive receives a frame, blocks until the frame is received.
     def __old_receive()
       # The receive may fail so we may need to retry.
-      while TRUE
+      while true
         begin
           used_socket = socket()
           return _receive(used_socket)
         rescue Stomp::Error::MaxReconnectAttempts
+          unless slog(:on_miscerr, log_params, "Reached MaxReconnectAttempts")
+            $stderr.print "Reached MaxReconnectAttempts\n"
+          end
           raise
         rescue
           @failure = $!
@@ -274,4 +285,3 @@ module Stomp
   end # class Connection
 
 end # module Stomp
-

data/lib/stomp/client.rb

@@ -88,6 +88,8 @@ module Stomp
 
       @logger = @parameters[:logger] ||= Stomp::NullLogger.new
       @start_timeout = @parameters[:start_timeout] || 0
+      @parameters[:client_main] = Thread::current
+      ## p [ "CLINDBG", @parameters[:client_main] ]
       check_arguments!()
 
       # p [ "cldbg01", @parameters ]
@@ -170,22 +172,26 @@ module Stomp
     # which will be used as a callback listener.
     # Accepts a transaction header ( :transaction => 'some_transaction_id' ).
     def subscribe(destination, headers = {})
-      raise "No listener given" unless block_given?
+      raise Stomp::Error::NoListenerGiven unless block_given?
+      headers = headers.symbolize_keys
+      raise Stomp::Error::DestinationRequired unless destination
       # use subscription id to correlate messages to subscription. As described in
       # the SUBSCRIPTION section of the protocol: http://stomp.github.com/.
       # If no subscription id is provided, generate one.
       headers = headers.merge(:id => build_subscription_id(destination, headers))
       if @listeners[headers[:id]]
-        raise "attempting to subscribe to a queue with a previous subscription"
+        raise Stomp::Error::DuplicateSubscription
       end
       @listeners[headers[:id]] = lambda {|msg| yield msg}
       @connection.subscribe(destination, headers)
     end
 
     # Unsubscribe from a subscription by name.
-    def unsubscribe(name, headers = {})
-      headers = headers.merge(:id => build_subscription_id(name, headers))
-      @connection.unsubscribe(name, headers)
+    def unsubscribe(destination, headers = {})
+      headers = headers.symbolize_keys
+      raise Stomp::Error::DestinationRequired unless destination
+      headers = headers.merge(:id => build_subscription_id(destination, headers))
+      @connection.unsubscribe(destination, headers)
       @listeners[headers[:id]] = nil
     end
 
@@ -243,6 +249,8 @@ module Stomp
     # block on receipt.
     # Accepts a transaction header ( :transaction => 'some_transaction_id' ).
     def publish(destination, message, headers = {})
+      headers = headers.symbolize_keys
+      raise Stomp::Error::DestinationRequired unless destination
       if block_given?
         headers = headers.merge(:receipt => register_receipt_listener(lambda {|r| yield r}))
       end
@@ -351,4 +359,3 @@ module Stomp
   end # Class
 
 end # Module
-

data/lib/stomp/connection.rb

@@ -156,6 +156,7 @@ module Stomp
       @transmit_semaphore = Mutex.new
       @read_semaphore = Mutex.new
       @socket_semaphore = Mutex.new
+      @gets_semaphore = Mutex.new
 
       @subscriptions = {}
       @failure = nil
@@ -335,12 +336,13 @@ module Stomp
 
     # Subscribe subscribes to a destination.  A subscription name is required.
     # For Stomp 1.1+ a session unique subscription ID is also required.
-    def subscribe(name, headers = {}, subId = nil)
+    def subscribe(destination, headers = {}, subId = nil)
       raise Stomp::Error::NoCurrentConnection if @closed_check && closed?
       raise Stomp::Error::ProtocolErrorEmptyHeaderKey if headers.has_key?("")
       raise Stomp::Error::ProtocolErrorEmptyHeaderValue if @protocol == Stomp::SPL_10 && headers.has_value?("")
       headers = headers.symbolize_keys
-      headers[:destination] = name
+      raise Stomp::Error::DestinationRequired unless destination
+      headers[:destination] = destination
       if @protocol >= Stomp::SPL_11
         raise Stomp::Error::SubscriptionRequiredError if (headers[:id].nil? && subId.nil?)
         headers[:id] = subId if headers[:id].nil?
@@ -350,7 +352,7 @@ module Stomp
 
       # Store the subscription so that we can replay if we reconnect.
       if @reliable
-        subId = name if subId.nil?
+        subId = destination if subId.nil?
         raise Stomp::Error::DuplicateSubscription if @subscriptions[subId]
         @subscriptions[subId] = headers
       end
@@ -360,12 +362,13 @@ module Stomp
 
     # Unsubscribe from a destination.   A subscription name is required.
     # For Stomp 1.1+ a session unique subscription ID is also required.
-    def unsubscribe(dest, headers = {}, subId = nil)
+    def unsubscribe(destination, headers = {}, subId = nil)
       raise Stomp::Error::NoCurrentConnection if @closed_check && closed?
       raise Stomp::Error::ProtocolErrorEmptyHeaderKey if headers.has_key?("")
       raise Stomp::Error::ProtocolErrorEmptyHeaderValue if @protocol == Stomp::SPL_10 && headers.has_value?("")
       headers = headers.symbolize_keys
-      headers[:destination] = dest
+      raise Stomp::Error::DestinationRequired unless destination
+      headers[:destination] = destination
       if @protocol >= Stomp::SPL_11
         raise Stomp::Error::SubscriptionRequiredError if (headers[:id].nil? && subId.nil?)
         headers[:id] = subId unless headers[:id]
@@ -374,7 +377,7 @@ module Stomp
       slog(:on_unsubscribe, log_params, headers)
       transmit(Stomp::CMD_UNSUBSCRIBE, headers)
       if @reliable
-        subId = dest if subId.nil?
+        subId = destination if subId.nil?
         @subscriptions.delete(subId)
       end
     end
@@ -387,6 +390,7 @@ module Stomp
       raise Stomp::Error::ProtocolErrorEmptyHeaderKey if headers.has_key?("")
       raise Stomp::Error::ProtocolErrorEmptyHeaderValue if @protocol == Stomp::SPL_10 && headers.has_value?("")
       headers = headers.symbolize_keys
+      raise Stomp::Error::DestinationRequired unless destination
       headers[:destination] = destination
       _headerCheck(headers)
       slog(:on_publish, log_params, message, headers)

data/lib/stomp/constants.rb

@@ -26,10 +26,10 @@ module Stomp
   SPL_11 = "1.1"
   SPL_12 = "1.2"
 
-  # Stomp 1.0 and 1.1
+  # Stomp 1.0 and 1.1 and 1.2
   SUPPORTED = [SPL_10, SPL_11, SPL_12]
 
-  # 1.9 Encoding Name
+  # UTF-8 Encoding Name
   UTF8 = "UTF-8"
   #
   # Octet 0
@@ -175,8 +175,10 @@ module Stomp
     ["SRP-RSA-AES-256-CBC-SHA","TLSv1/SSLv3",256,256],
   ]
 
+  HAND_SHAKE_DATA = "\x15\x03\x03\x00\x02\x02\n"
+
   original_verbose, $VERBOSE = $VERBOSE, nil # try to shut off warnings
-  
+
   # stomp URL regex pattern, for e.g. login:passcode@host:port or host:port
   URL_REPAT = '((([\w~!@#$%^&*()\-+=.?:<>,.]*\w):([\w~!@#$%^&*()\-+=.?:<>,.]*))?@)?([\w\.\-]+):(\d+)'
 
@@ -185,5 +187,5 @@ module Stomp
   FAILOVER_REGEX = /^failover:(\/\/)?\(stomp(\+ssl)?:\/\/#{URL_REPAT}(,stomp(\+ssl)?:\/\/#{URL_REPAT})*\)(\?(.*))?$/
 
   $VERBOSE = original_verbose
-  
+
 end # Module Stomp

data/lib/stomp/errors.rb

@@ -5,6 +5,22 @@ module Stomp
   # Module level container for Stomp gem error classes.
   module Error
 
+    # NoListenerGiven is raised if:
+    # * No listener block is passed to Client#subscribe
+    class NoListenerGiven < RuntimeError
+      def message
+        "No listener given"
+      end
+    end
+
+    # DestinationRequired is raised if:
+    # * No destination is passed to subscribe, unsubscribe, publish
+    class DestinationRequired < RuntimeError
+      def message
+        "Destination required"
+      end
+    end
+
     # InvalidFormat is raised if:
     # * During frame parsing if a malformed frame is detected.
     class InvalidFormat < RuntimeError
@@ -216,7 +232,7 @@ module Stomp
       end
     end
 
-    # LoggerConnectionError is not raised by the gem.  It may be 
+    # LoggerConnectionError is not raised by the gem.  It may be
     # raised by client logic in callback logger methods to signal
     # that a connection should not proceed.
     class LoggerConnectionError < RuntimeError
@@ -298,7 +314,14 @@ module Stomp
       end
     end
 
+    # HandShakeDetectedError is raised if:
+    # * A normal read detects inbound handskake data
+    class HandShakeDetectedError < RuntimeError
+      def message
+        "Handshake data found, possible mismatched port and sslparams"
+      end
+    end
+
   end # module Error
 
 end # module Stomp
-

data/lib/stomp/version.rb

@@ -4,10 +4,10 @@ module Stomp
 
   # Define the gem version.
   module Version  #:nodoc: all
-    MAJOR =  1
-    MINOR =  4
-    PATCH = "3"
-    # PATCH = "3.plvl.001"
+    MAJOR = 1
+    MINOR = 4
+    PATCH = 4
+    # PATCH = "4.plvl.001"
     STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
   end
 end

data/spec/client_spec.rb

@@ -132,6 +132,7 @@ describe Stomp::Client do
   describe "(created with positional params)" do
     before(:each) do
       @client = Stomp::Client.new('testlogin', 'testpassword', 'localhost', '12345', false)
+	  @cli_thread = @client.parameters[:client_main]
     end
 
     it "should properly parse the URL provided" do
@@ -140,7 +141,8 @@ describe Stomp::Client do
                                                               :host => 'localhost',
                                                               :port => 12345}],
                                                   :logger => null_logger,
-                                                  :reliable => false)
+                                                  :reliable => false,
+												:client_main => @cli_thread)
       Stomp::Client.new('testlogin', 'testpassword', 'localhost', '12345', false)
     end
 
@@ -151,6 +153,7 @@ describe Stomp::Client do
   describe "(created with non-authenticating stomp:// URL and non-TLD host)" do
     before(:each) do
       @client = Stomp::Client.new('stomp://foobar:12345')
+	  @cli_thread = @client.parameters[:client_main]
     end
 
     it "should properly parse the URL provided" do
@@ -159,7 +162,8 @@ describe Stomp::Client do
                                                               :host => 'foobar',
                                                               :port => 12345}],
                                                   :logger => null_logger,
-                                                  :reliable => false)
+                                                  :reliable => false,
+												:client_main => @cli_thread)
       Stomp::Client.new('stomp://foobar:12345')
     end
 
@@ -171,6 +175,7 @@ describe Stomp::Client do
 
     before(:each) do
       @client = Stomp::Client.new('stomp://foo-bar:12345')
+	  @cli_thread = @client.parameters[:client_main]
     end
 
     it "should properly parse the URL provided" do
@@ -179,7 +184,8 @@ describe Stomp::Client do
                                                               :host => 'foo-bar',
                                                               :port => 12345}],
                                                   :logger => null_logger,
-                                                  :reliable => false)
+                                                  :reliable => false,
+												:client_main => @cli_thread)
       Stomp::Client.new('stomp://foo-bar:12345')
     end
 
@@ -191,6 +197,7 @@ describe Stomp::Client do
 
     before(:each) do
       @client = Stomp::Client.new('stomp://test-login:testpasscode@foobar:12345')
+	  @cli_thread = @client.parameters[:client_main]
     end
 
     it "should properly parse the URL provided" do
@@ -199,7 +206,8 @@ describe Stomp::Client do
                                                               :host => 'foobar',
                                                               :port => 12345}],
                                                   :logger => null_logger,
-                                                  :reliable => false)
+                                                  :reliable => false,
+												:client_main => @cli_thread)
       Stomp::Client.new('stomp://test-login:testpasscode@foobar:12345')
     end
 
@@ -211,6 +219,7 @@ describe Stomp::Client do
 
     before(:each) do
       @client = Stomp::Client.new('stomp://test-login:testpasscode@foo-bar:12345')
+	  @cli_thread = @client.parameters[:client_main]
     end
 
     it "should properly parse the URL provided" do
@@ -219,7 +228,8 @@ describe Stomp::Client do
                                                               :host => 'foo-bar',
                                                               :port => 12345}],
                                                   :logger => null_logger,
-                                                  :reliable => false)
+                                                  :reliable => false,
+												:client_main => @cli_thread)
       Stomp::Client.new('stomp://test-login:testpasscode@foo-bar:12345')
     end
 
@@ -231,6 +241,7 @@ describe Stomp::Client do
 
     before(:each) do
       @client = Stomp::Client.new('stomp://host.foobar.com:12345')
+	  @cli_thread = @client.parameters[:client_main]
     end
 
     after(:each) do
@@ -242,7 +253,8 @@ describe Stomp::Client do
                                                               :host => 'host.foobar.com',
                                                               :port => 12345}],
                                                   :logger => null_logger,
-                                                  :reliable => false)
+                                                  :reliable => false,
+												:client_main => @cli_thread)
       Stomp::Client.new('stomp://host.foobar.com:12345')
     end
 
@@ -254,6 +266,7 @@ describe Stomp::Client do
 
     before(:each) do
       @client = Stomp::Client.new('stomp://testlogin:testpasscode@host.foobar.com:12345')
+	  @cli_thread = @client.parameters[:client_main]
     end
 
     it "should properly parse the URL provided" do
@@ -262,7 +275,8 @@ describe Stomp::Client do
                                                               :host => 'host.foobar.com',
                                                               :port => 12345}],
                                                   :logger => null_logger,
-                                                  :reliable => false)
+                                                  :reliable => false,
+												:client_main => @cli_thread)
       Stomp::Client.new('stomp://testlogin:testpasscode@host.foobar.com:12345')
     end
 
@@ -272,6 +286,8 @@ describe Stomp::Client do
   
   describe "(created with failover URL)" do
     before(:each) do
+	  @client = Stomp::Client.new('failover://(stomp://login1:passcode1@localhost:61616,stomp://login2:passcode2@remotehost:61617)')
+	  @cli_thread = @client.parameters[:client_main]
       #default options
       @parameters = {
         :initial_reconnect_delay => 0.01,
@@ -286,17 +302,14 @@ describe Stomp::Client do
     end
     it "should properly parse a URL with failover://" do
       url = "failover://(stomp://login1:passcode1@localhost:61616,stomp://login2:passcode2@remotehost:61617)"
-
       @parameters[:hosts] = [
         {:login => "login1", :passcode => "passcode1", :host => "localhost", :port => 61616, :ssl => false},
         {:login => "login2", :passcode => "passcode2", :host => "remotehost", :port => 61617, :ssl => false}
       ]
-
       @parameters.merge!({:logger => null_logger})
-      
       expect(Stomp::Connection).to receive(:new).with(@parameters)
-      
-      client = Stomp::Client.new(url)
+	  @parameters[:client_main] = @cli_thread
+	  client = Stomp::Client.new(url)
       expect(client.parameters).to eq(@parameters)
     end
     
@@ -310,9 +323,8 @@ describe Stomp::Client do
       ]
       
       @parameters.merge!({:logger => null_logger})
-      
+	  @parameters[:client_main] = @cli_thread
       expect(Stomp::Connection).to receive(:new).with(@parameters)
-      
       client = Stomp::Client.new(url)
       expect(client.parameters).to eq(@parameters)
     end
@@ -326,10 +338,11 @@ describe Stomp::Client do
       ]
       
       @parameters.merge!({:logger => null_logger})
-      
+      @parameters[:client_main] = @cli_thread
       expect(Stomp::Connection).to receive(:new).with(@parameters)
       
       client = Stomp::Client.new(url)
+	  @parameters[:client_main] = client.parameters[:client_main]
       expect(client.parameters).to eq(@parameters)
     end
     
@@ -342,10 +355,11 @@ describe Stomp::Client do
       ]
       
       @parameters.merge!({:logger => null_logger})
-      
+      @parameters[:client_main] = @cli_thread
       expect(Stomp::Connection).to receive(:new).with(@parameters)
       
       client = Stomp::Client.new(url)
+	  @parameters[:client_main] = client.parameters[:client_main]
       expect(client.parameters).to eq(@parameters)
     end
     
@@ -373,10 +387,11 @@ describe Stomp::Client do
       ]
       
       @parameters.merge!({:logger => null_logger})
-      
+      @parameters[:client_main] = @cli_thread
       expect(Stomp::Connection).to receive(:new).with(@parameters)
       
       client = Stomp::Client.new(url)
+	  @parameters[:client_main] = client.parameters[:client_main]
       expect(client.parameters).to eq(@parameters)
     end
     
@@ -419,7 +434,7 @@ describe Stomp::Client do
       describe 'given headers hash' do
         subject { headers }
         it 'is immutable' do
-          is_expected.to match(original_headers)
+          expect match(original_headers)
         end
       end
     end