stomp 1.3.5 → 1.4.0

data/Rakefile

@@ -19,10 +19,12 @@ require 'rspec/core/rake_task'
 require "stomp/version"
 
 begin
-  require "hanna/rdoctask"
+  require "hanna-nouveau"
+  have_hanna = true
 rescue LoadError => e
-  require "rdoc/task"
+  have_hanna = false
 end
+require "rdoc/task"
 
 begin
   require 'jeweler'
@@ -30,7 +32,7 @@ begin
     gem.name = "stomp"
     gem.version = Stomp::Version::STRING
     gem.summary = %Q{Ruby client for the Stomp messaging protocol}
-    gem.license = "Apache 2.0"
+    gem.license = "Apache-2.0"
     gem.description = %Q{Ruby client for the Stomp messaging protocol.  Note that this gem is no longer supported on rubyforge.}
     gem.email = ["brianm@apache.org", 'marius@stones.com', 'morellon@gmail.com',
        'allard.guy.m@gmail.com' ]
@@ -38,9 +40,6 @@ begin
     gem.authors = ["Brian McCallister", 'Marius Mathiesen', 'Thiago Morello',
         'Guy M. Allard']
     gem.add_development_dependency "rspec", '>= 2.14.1'
-    gem.extra_rdoc_files = [ "README.rdoc", "CHANGELOG.rdoc", "LICENSE",
-      "lib/**/*.rb", "examples/**/*.rb",
-      "test/**/*.rb" ]
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
@@ -61,12 +60,14 @@ RSpec::Core::RakeTask.new('spec:rcov') do |t|
 end
 
 Rake::RDocTask.new do |rdoc|
-  rdoc.main = "README.rdoc"
+  rdoc.main = "README.md"
   rdoc.rdoc_dir = "doc"
   rdoc.title = "Stomp"
   rdoc.options += %w[ --line-numbers --inline-source --charset utf-8 ]
-  rdoc.rdoc_files.include("README.rdoc", "CHANGELOG.rdoc", "lib/**/*.rb", "examples/**/*.rb",
-    "test/**/*.rb")
+  if have_hanna
+    rdoc.options += %w[ --format hanna  ]
+  end
+  rdoc.rdoc_files.include("README.md", "CHANGELOG.md", "lib/**/*.rb")
 end
 
 Rake::TestTask.new do |t|
@@ -77,5 +78,3 @@ end
 
 task :default => :spec
 
-
-

data/adhoc/.gitignore

@@ -0,0 +1,7 @@
+# No html in this directory
+*.html
+*.htm
+# Typical backup files
+*~
+*.bak
+

data/adhoc/README.md

@@ -0,0 +1,16 @@
+<link href="http://kevinburke.bitbucket.org/markdowncss/markdown.css" rel="stylesheet"></link>
+
+# The Ruby stomp Gem - Adhoc Items #
+
+This directory will contain a variety of artifacts.
+
+It is envisioned that content will mostly be of interest to gem developers.
+However gem clients may find items of interest here as well.
+
+## Issue 121 ##
+
+Much of the initial work in this directory has focused on
+recreating / confirming the high memory use described in
+[issue 121](https://github.com/stompgem/stomp/issues/121).
+
+Resolution of that issue is TDB (2016.05.25).

data/adhoc/issue121_01.rb

@@ -0,0 +1,129 @@
+# -*- encoding: utf-8 -*-
+
+require 'stomp'
+
+# Focus on this gem's capabilities.
+# require 'memory_profiler'
+require 'memory-profiler'
+
+if Kernel.respond_to?(:require_relative)
+  require_relative("stomp_adhoc_common")
+else
+  $LOAD_PATH << File.dirname(__FILE__)
+  require "stomp_adhoc_common"
+end
+include Stomp11Common
+
+# Initial testing around issue #121.
+
+class Issue121Examp01
+
+  attr_reader :client, :session
+
+  # Initialize.
+  def initialize(topic = false)
+    @client, @session, @topic = nil, nil, topic
+    @nmsgs = nmsgs()
+    @queue = make_destination("issue121/test_01")
+    @id = "issue121_01"
+    @block = cli_block()
+  end # initialize
+
+  # Startup
+  def start
+    #
+    client_hdrs = {"accept-version" => "1.1,1.2",
+      "host" => virt_host,
+    }
+    #
+    client_hash = { :hosts => [
+        {:login => login(), :passcode => passcode(), :host => host(), :port => port()},
+      ],
+      :connect_headers => client_hdrs,
+    }
+    #
+    @client = Stomp::Client.new(client_hash)
+    puts "START: Client Connect complete"
+    raise "START: Connection failed!!" unless @client.open?
+    raise "START: Unexpected protocol level!!" if @client.protocol() == Stomp::SPL_10
+    cf = @client.connection_frame()
+    puts "START: Connection frame\n#{cf}"
+    raise "START: Connect error!!: #{cf.body}" if @client.connection_frame().command == Stomp::CMD_ERROR
+    @session = @client.connection_frame().headers['session']
+    puts "START: Queue/Topic Name: #{@queue}"
+    puts "START: Session: #{@session}"
+    puts "START: Block: #{@block}"
+    $stdout.flush
+  end # start
+
+  #
+  def shutdown
+    @client.close
+    puts "SHUT: Shutdown complete"
+  end # shutdown
+
+  # pub
+  def publish
+    m = "Message: "
+    nm = 0
+    @nmsgs.times do |n|
+      nm += 1
+      puts "PUB: NEXT MESSAGE NUMBER: #{nm}"
+      mo = "#{m} #{n}"
+      puts "PUB: PAYLOAD: #{mo}"
+      hs = {:session => @session}
+     if @block
+        ip = false
+        @client.publish(@queue,
+          mo,
+          hs) {|m|
+            puts "PUB: HAVE_RECEIPT:\nID: #{m.headers['receipt-id']}"
+            ip = m
+        }
+        sleep 0.01 until ip
+      else
+        @client.publish(@queue, mo, hs)
+      end # if @block
+
+    end # @nmsgs.times do
+
+  end # publish
+
+  # sub
+  def subscribe
+    puts "SUB: Subscribe starts For: #{@queue}"
+    rmc, done = 0, false
+    sh = {:id => "#{@id}", :ack => "auto"}
+    @client.subscribe(@queue, sh) {|m|
+      rmc += 1
+      rm = m
+      puts "SUB: HAVE_MESSAGE:\n#{rm}"
+      if rmc >= @nmsgs
+        puts "SUB: Subscribe is ending for #{@queue}"
+        done = true
+        Thread.done
+      end
+    }
+    sleep 0.01 until done
+    puts "SUB: Receives Done For: #{@queue}"
+  end # subscribe
+
+end # class
+
+#
+# puts "BEG: Memory Profiler Version is: #{MemoryProfiler::VERSION}"
+MemoryProfiler::start_daemon( :limit=>5, :delay=>10, :marshal_size=>true, :sort_by=>:absdelta )
+#
+5.times do |i|
+  rpt  = MemoryProfiler.start( :limit=>10 ) do
+    e = Issue121Examp01.new
+    e.start
+    e.publish
+    e.subscribe
+    e.shutdown
+  end
+  puts MemoryProfiler.format(rpt)
+  sleep 1
+end
+#
+MemoryProfiler::stop_daemon

data/adhoc/issue121_01_conn.rb

@@ -0,0 +1,158 @@
+# -*- encoding: utf-8 -*-
+
+require 'stomp'
+require 'tmpdir'
+
+# Focus on this gem's capabilities.
+require 'memory_profiler'
+# require 'memory-profiler'
+
+if Kernel.respond_to?(:require_relative)
+  require_relative("stomp_adhoc_common")
+  require_relative("payload_generator")
+else
+  $LOAD_PATH << File.dirname(__FILE__)
+  require "stomp_adhoc_common"
+  require("payload_generator")
+end
+include Stomp11Common
+
+# Next of testing around issue #121.
+# Different memory profiler gem.
+# Use Stomp#connection to merely send
+
+class Issue121Examp01Conn
+
+  attr_reader :connection, :session
+
+  # Initialize.
+  def initialize(topic = false)
+    @connection, @session, @topic = nil, nil, topic
+    @nmsgs = nmsgs()
+    @queue = make_destination("issue121/test_01_conn")
+    @id = "issue121_01_conn"
+    @getreceipt = conn_receipt()
+    #
+    @cmin, @cmax = 1292, 67782 # From the issue discussion
+    PayloadGenerator::initialize(min= @cmin, max= @cmax)
+    @ffmts = "%16.6f"
+    #
+    mps = 5.6 # see issue discussion
+    @to, @nmts, @nts, @umps = 0.0, Time.now.to_f, @nmsgs, mps
+    @tslt = 1.0 / @umps
+  end # initialize
+
+  # Startup
+  def start
+    #
+    connect_hdrs = {"accept-version" => "1.1,1.2",
+      "host" => virt_host,
+    }
+    #
+    connect_hash = { :hosts => [
+        {:login => login(), :passcode => passcode(), :host => host(), :port => port()},
+      ],
+      :connect_headers => connect_hdrs,
+    }
+    #
+    @connection = Stomp::Connection.new(connect_hash)
+    puts "START: Connection Connect complete"
+    raise "START: Connection failed!!" unless @connection.open?
+    raise "START: Unexpected protocol level!!" if @connection.protocol == Stomp::SPL_10
+    cf = @connection.connection_frame
+    puts "START: Connection frame\n#{cf}"
+    raise "START: Connect error!!: #{cf.body}" if @connection.connection_frame.command == Stomp::CMD_ERROR
+    @session = @connection.connection_frame.headers['session']
+    puts "START: Queue/Topic Name: #{@queue}"
+    puts "START: Session: #{@session}"
+    puts "START: NMSGS: #{@nmsgs}"
+    puts "START: Receipt: #{@getreceipt}"
+    puts "START: Wanted Messages Per Second: #{@umps}"
+    puts "START: Sleep Time: #{@tslt}"
+    $stdout.flush
+  end # start
+
+  #
+  def shutdown
+    @connection.disconnect()
+    #
+    te = Time.now.to_f
+    et = te - @nmts
+    avgsz = @to / @nts
+    mps = @nts.to_f / et
+    #
+    fet = sprintf(@ffmts, et)
+    favgsz = sprintf(@ffmts, avgsz)
+    fmps = sprintf(@ffmts, mps)
+    #
+    sep = "=" * 72
+    puts sep
+    puts "\tNumber of payloads generated: #{@nts}"
+    puts "\tMin Length: #{@cmin}, Max Length: #{@cmax}"
+    puts "\tAVG_SIZE: #{favgsz}, ELAPS_SEC: #{fet}(seconds)"
+    puts "\tNMSGS_PER_SEC: #{fmps}"
+    puts sep
+    #
+    puts "SHUT: Shutdown complete"
+    $stdout.flush
+  end # shutdown
+
+  #
+  def msg_handler
+    m = "Message: "
+    nm = 0
+
+    @nmsgs.times do |n|
+      nm += 1
+      puts "MSH: NEXT MESSAGE NUMBER: #{nm}"; $stdout.flush
+      mo = PayloadGenerator::payload()
+      @to += mo.bytesize()
+
+      if @getreceipt
+        uuid = @connection.uuid()
+        puts "MSH: Receipt id wanted is #{uuid}"
+        hs = {:session => @session, :receipt => uuid}
+      else
+        hs = {:session => @session}
+      end
+
+      # Move data out the door
+      @connection.publish(@queue, mo, hs)
+
+      if @getreceipt
+        r = @connection.receive()
+        puts "MSH: received receipt, id is #{r.headers['receipt-id']}"
+        raise if uuid != r.headers['receipt-id']
+      end
+      #
+      puts "MSH: start user sleep"
+      sleep @tslt # see issue discussion
+      puts "MSH: end user sleep"
+      $stdout.flush
+    end # @nmsgs.times do
+
+    puts "MSH: end of msg_handler"
+    $stdout.flush
+  end # msg_handler
+
+end # class
+
+#
+1.times do |i|
+  rpt  = MemoryProfiler.report do
+    e = Issue121Examp01Conn.new
+    e.start
+    e.msg_handler
+    # No subscribes here, just msg_handler
+    # See discussion in issue #121
+    e.shutdown
+  end
+  n = Time.now
+  nf = "memory_profiler-ng"
+  nf << n.strftime("%Y%m%dT%H%M%S.%N%Z")
+  where_name = File::join(Dir::tmpdir(), nf)
+  rpt.pretty_print(to_file: where_name  )
+  # sleep 1
+end
+#
+

data/adhoc/issue121_02.rb

@@ -0,0 +1,152 @@
+# -*- encoding: utf-8 -*-
+
+require 'stomp'
+
+# Focus on this gem's capabilities.
+# require 'memory_profiler'
+require 'memory-profiler'
+
+if Kernel.respond_to?(:require_relative)
+  require_relative("stomp_adhoc_common")
+  require_relative("payload_generator")
+else
+  $LOAD_PATH << File.dirname(__FILE__)
+  require "stomp_adhoc_common"
+  require("payload_generator")
+end
+include Stomp11Common
+
+# Round 2 of testing around issue #121.
+
+class Issue121Examp02
+
+  attr_reader :client, :session
+
+  # Initialize.
+  def initialize(topic = false)
+    @client, @session, @topic = nil, nil, topic
+    @nmsgs = nmsgs()
+    @queue = make_destination("issue121/test_02")
+    @id = "issue121_02"
+    @block = cli_block()
+    #
+    @cmin, @cmax = 1292, 67782 # From the issue discussion
+    PayloadGenerator::initialize(min= @cmin, max= @cmax)
+    @ffmts = "%16.6f"
+    #
+    mps = 5.6 # see issue discussion
+    @to, @nmts, @nts, @umps = 0.0, Time.now.to_f, @nmsgs, mps
+    @tslt = 1.0 / @umps
+  end # initialize
+
+  # Startup
+  def start
+    #
+    client_hdrs = {"accept-version" => "1.1,1.2",
+      "host" => virt_host,
+    }
+    #
+    client_hash = { :hosts => [
+        {:login => login(), :passcode => passcode(), :host => host(), :port => port()},
+      ],
+      :connect_headers => client_hdrs,
+    }
+    #
+    @client = Stomp::Client.new(client_hash)
+    puts "START: Client Connect complete"
+    raise "START: Connection failed!!" unless @client.open?
+    raise "START: Unexpected protocol level!!" if @client.protocol() == Stomp::SPL_10
+    cf = @client.connection_frame()
+    puts "START: Connection frame\n#{cf}"
+    raise "START: Connect error!!: #{cf.body}" if @client.connection_frame().command == Stomp::CMD_ERROR
+    @session = @client.connection_frame().headers['session']
+    puts "START: Queue/Topic Name: #{@queue}"
+    puts "START: Session: #{@session}"
+    puts "START: NMSGS: #{@nmsgs}"
+    puts "START: Block: #{@block}"
+    puts "START: Wanted Messages Per Second: #{@umps}"
+    puts "START: Sleep Time: #{@tslt}"
+    $stdout.flush
+  end # start
+
+  #
+  def shutdown
+    @client.close
+    #
+    te = Time.now.to_f
+    et = te - @nmts
+    avgsz = @to / @nts
+    mps = @nts.to_f / et
+    #
+    fet = sprintf(@ffmts, et)
+    favgsz = sprintf(@ffmts, avgsz)
+    fmps = sprintf(@ffmts, mps)
+    #
+    sep = "=" * 72
+    puts sep
+    puts "\tNumber of payloads generated: #{@nts}"
+    puts "\tMin Length: #{@cmin}, Max Length: #{@cmax}"
+    puts "\tAVG_SIZE: #{favgsz}, ELAPS_SEC: #{fet}(seconds)"
+    puts "\tNMSGS_PER_SEC: #{fmps}"
+    puts sep
+    #
+    puts "SHUT: Shutdown complete"
+    $stdout.flush
+  end # shutdown
+
+  # pub
+  def publish
+    m = "Message: "
+    nm = 0
+
+    @nmsgs.times do |n|
+      nm += 1
+      puts "PUB: NEXT MESSAGE NUMBER: #{nm}"; $stdout.flush
+      mo = PayloadGenerator::payload()
+      @to += mo.bytesize()
+      hs = {:session => @session}
+
+      if @block
+        ip = false
+        @client.publish(@queue,
+          mo,
+          hs) {|m|
+            puts "PUB: HAVE_RECEIPT:\nID: #{m.headers['receipt-id']}"
+            $stdout.flush
+            ip = m
+        }
+        sleep 0.01 until ip
+      else
+        @client.publish(@queue, mo, hs)
+      end # if @block
+
+      puts "PUB: start user sleep"
+      sleep @tslt # see issue discussion
+      puts "PUB: end user sleep"
+      $stdout.flush
+    end # @nmsgs.times do
+
+    puts "PUB: end of publish"
+    $stdout.flush
+  end # publish
+
+end # class
+
+#
+# :limit => is max number of classes to report on
+MemoryProfiler::start_daemon( :limit=>25, :delay=>10, :marshal_size=>true, :sort_by=>:absdelta )
+#
+1.times do |i|
+  rpt  = MemoryProfiler.start( :limit=> 25 ) do
+    e = Issue121Examp02.new
+    e.start
+    e.publish
+    # No subscribes here, just publish
+    # See discussion in issue #121
+    e.shutdown
+  end
+  puts MemoryProfiler.format(rpt)
+  sleep 1
+end
+#
+MemoryProfiler::stop_daemon

data/adhoc/issue121_03.rb

@@ -0,0 +1,157 @@
+# -*- encoding: utf-8 -*-
+
+require 'stomp'
+require 'tmpdir'
+
+# Focus on this gem's capabilities.
+require 'memory_profiler'
+# require 'memory-profiler'
+
+if Kernel.respond_to?(:require_relative)
+  require_relative("stomp_adhoc_common")
+  require_relative("payload_generator")
+else
+  $LOAD_PATH << File.dirname(__FILE__)
+  require "stomp_adhoc_common"
+  require("payload_generator")
+end
+include Stomp11Common
+
+# Round 3 of testing around issue #121.
+# Different memory profiler gem.
+
+class Issue121Examp03
+
+  attr_reader :client, :session
+
+  # Initialize.
+  def initialize(topic = false)
+    @client, @session, @topic = nil, nil, topic
+    @nmsgs = nmsgs()
+    @queue = make_destination("issue121/test_03")
+    @id = "issue121_03"
+    @block = cli_block()
+    #
+    @cmin, @cmax = 1292, 67782 # From the issue discussion
+    PayloadGenerator::initialize(min= @cmin, max= @cmax)
+    @ffmts = "%16.6f"
+    #
+    mps = 5.6 # see issue discussion
+    @to, @nmts, @nts, @umps = 0.0, Time.now.to_f, @nmsgs, mps
+    @tslt = 1.0 / @umps
+  end # initialize
+
+  # Startup
+  def start
+    #
+    client_hdrs = {"accept-version" => "1.1,1.2",
+      "host" => virt_host,
+    }
+    #
+    client_hash = { :hosts => [
+        {:login => login(), :passcode => passcode(), :host => host(), :port => port()},
+      ],
+      :connect_headers => client_hdrs,
+    }
+    #
+    @client = Stomp::Client.new(client_hash)
+    puts "START: Client Connect complete"
+    raise "START: Connection failed!!" unless @client.open?
+    raise "START: Unexpected protocol level!!" if @client.protocol() == Stomp::SPL_10
+    cf = @client.connection_frame()
+    puts "START: Connection frame\n#{cf}"
+    raise "START: Connect error!!: #{cf.body}" if @client.connection_frame().command == Stomp::CMD_ERROR
+    @session = @client.connection_frame().headers['session']
+    puts "START: Queue/Topic Name: #{@queue}"
+    puts "START: Session: #{@session}"
+    puts "START: NMSGS: #{@nmsgs}"
+    puts "START: Block: #{@block}"
+    puts "START: Wanted Messages Per Second: #{@umps}"
+    puts "START: Sleep Time: #{@tslt}"
+    $stdout.flush
+  end # start
+
+  #
+  def shutdown
+    @client.close
+    #
+    te = Time.now.to_f
+    et = te - @nmts
+    avgsz = @to / @nts
+    mps = @nts.to_f / et
+    #
+    fet = sprintf(@ffmts, et)
+    favgsz = sprintf(@ffmts, avgsz)
+    fmps = sprintf(@ffmts, mps)
+    #
+    sep = "=" * 72
+    puts sep
+    puts "\tNumber of payloads generated: #{@nts}"
+    puts "\tMin Length: #{@cmin}, Max Length: #{@cmax}"
+    puts "\tAVG_SIZE: #{favgsz}, ELAPS_SEC: #{fet}(seconds)"
+    puts "\tNMSGS_PER_SEC: #{fmps}"
+    puts sep
+    #
+    puts "SHUT: Shutdown complete"
+    $stdout.flush
+  end # shutdown
+
+  # pub
+  def publish
+    m = "Message: "
+    nm = 0
+
+    @nmsgs.times do |n|
+      nm += 1
+      puts "PUB: NEXT MESSAGE NUMBER: #{nm}"; $stdout.flush
+      mo = PayloadGenerator::payload()
+      @to += mo.bytesize()
+      hs = {:session => @session}
+
+      if @block
+        ip = false
+        @client.publish(@queue,
+          mo,
+          hs) {|m|
+            puts "PUB: HAVE_RECEIPT:\nID: #{m.headers['receipt-id']}"
+            $stdout.flush
+            ip = m
+        }
+        sleep 0.01 until ip
+      else
+        @client.publish(@queue, mo, hs)
+      end # if @block
+
+      if nm < @nmsgs
+        puts "PUB: start user sleep"
+        sleep @tslt # see issue discussion
+        puts "PUB: end user sleep"
+      end
+      $stdout.flush
+    end # @nmsgs.times do
+
+    puts "PUB: end of publish"
+    $stdout.flush
+  end # publish
+
+end # class
+
+#
+1.times do |i|
+  rpt  = MemoryProfiler.report do
+    e = Issue121Examp03.new
+    e.start
+    e.publish
+    # No subscribes here, just publish
+    # See discussion in issue #121
+    e.shutdown
+  end
+  n = Time.now
+  nf = "memory_profiler-ng"
+  nf << n.strftime("%Y%m%dT%H%M%S.%N%Z")
+  where_name = File::join(Dir::tmpdir(), nf)
+  rpt.pretty_print(to_file: where_name  )
+  # sleep 1
+end
+#
+

data/adhoc/payload_generator.rb

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+
+class PayloadGenerator
+
+  private
+
+  @@BSTRING = ""
+
+  public
+
+  def self.initialize(min = 1, max = 4096)
+    srand()
+    #
+    @@min, @@max = min, max
+    if @@min > @@max
+      @@min, @@max = @@max, @@min
+      warn "Swapping min and max values"
+    end
+    #
+    @@BSTRING = "9" * @@max
+    nil
+  end # of initialize
+
+  def self.payload
+    i = rand(@@max - @@min)
+    i = 1 if i == 0
+    i += @@min 
+    # puts "DBI: #{i}"
+    @@BSTRING.byteslice(0, i)
+  end
+
+end # of class