stomp 1.2.4 → 1.2.5

data/examples/conn11_ex2.rb

@@ -11,68 +11,77 @@ else
   require "stomp11_common"
 end
 include Stomp11Common
+
 #
-# Stomp 1.1 Connection Example 1
-# ==============================
+# == Stomp 1.1 Connection Example 2
 #
 # Purpose: to demonstrate a connect and disconnect sequence using Stomp 1.1.
 #
 # This example is like the 'conn11_ex1.rb' example except that a 'hashed'
 # connect request is made.
 #
-# Create connection headers
-# =========================
-#
-# The two headers used here are _required_ by the specification.
-#
-conn_hdrs = {"accept-version" => "1.1",    # Demand a 1.1 connection (use a CSV list if you will consider multiple versions)
+class Connection11Example2
+  # Initialize.
+  def initialize
+  end
+  # Run example.
+  def run
+    # Create connection headers
+    # =========================
+    #
+    # The two headers used here are _required_ by the specification.
+    #
+    conn_hdrs = {"accept-version" => "1.1",    # Demand a 1.1 connection (use a CSV list if you will consider multiple versions)
       "host" => virt_host,                 # The 1.1 vhost (could be different than connection host)
     }                                      # No heartbeats here:  there will be none for this connection
-#
-# Create the connect hash.
-# ========================
-#
-conn_hash = { :hosts => [ 
-      {:login => login, :passcode => passcode, :host => host, :port => port},
+    #
+    # Create the connect hash.
+    # ========================
+    #
+    conn_hash = { :hosts => [
+        {:login => login, :passcode => passcode, :host => host, :port => port},
       ],
       :reliable => false, # Override default
       :connect_headers => conn_hdrs,
     }
+    #
+    # Get a connection
+    # ================
+    #
+    conn = Stomp::Connection.new(conn_hash)
+    puts "Connection complete"
+    #
+    # Let's just do some sanity checks, and look around.
+    #
+    raise "Connection failed!!" unless conn.open?
+    #
+    # Is this really a 1.1 conection? ('protocol' is a read only connection
+    # instance variable. The value will be '1.0' for those types of connections.)
+    #
+    raise "Unexpected protocol level" if conn.protocol != Stomp::SPL_11
+    #
+    # The broker _could_ have returned an ERROR frame (unlikely).
+    #
+    raise "Connect error: #{conn.connection_frame.body}" if conn.connection_frame.command == Stomp::CMD_ERROR
+    #
+    # Examine the CONNECT response (the connection_frame).
+    #
+    puts "Connected Headers required to be present:"
+    puts "Connect version - \t#{conn.connection_frame.headers['version']}"
+    puts
+    puts "Connected Headers that are optional:"
+    puts "Connect server - \t\t#{conn.connection_frame.headers['server']}"
+    puts "Session ID - \t\t\t#{conn.connection_frame.headers['session']}"
+    puts "Server requested heartbeats - \t#{conn.connection_frame.headers['heart-beat']}"
+    #
+    # Finally disconnect
+    # ==================
+    #
+    conn.disconnect   # Business as usual, just like 1.0
+    puts "Disconnect complete"
+  end
+end
 #
-# Get a connection
-# ================
-#
-conn = Stomp::Connection.new(conn_hash)
-puts "Connection complete"
-#
-# Let's just do some sanity checks, and look around.
-#
-raise "Connection failed!!" unless conn.open?
-#
-# Is this really a 1.1 conection? ('protocol' is a read only connection
-# instance variable. The value will be '1.0' for those types of connections.)
-#
-raise "Unexpected protocol level" if conn.protocol != Stomp::SPL_11
-#
-# The broker _could_ have returned an ERROR frame (unlikely).
-#
-raise "Connect error: #{conn.connection_frame.body}" if conn.connection_frame.command == Stomp::CMD_ERROR
-#
-# Examine the CONNECT response (the connection_frame).
-#
-puts "Connected Headers required to be present:"
-puts "Connect version - \t#{conn.connection_frame.headers['version']}"
-puts
-puts "Connected Headers that are optional:"
-puts "Connect broker - \t\t#{conn.connection_frame.headers['broker']}"
-puts "Session ID - \t\t\t#{conn.connection_frame.headers['session']}"
-puts "Server requested heartbeats - \t#{conn.connection_frame.headers['heart-beat']}"
-#
-# Finally disconnect
-# ==================
-#
-conn.disconnect   # Business as usual, just like 1.0
-puts "Disconnect complete"
-
-
+e = Connection11Example2.new
+e.run
 

data/examples/conn11_hb1.rb

@@ -13,36 +13,45 @@ else
   require "slogger"
 end
 include Stomp11Common
+
 #
-# Stomp 1.1 Heartbeat Example 1
-# =============================
+# == Stomp 1.1 Heartbeat Example 1
 #
 # Purpose: to demonstrate that heart beats can work.
 #
-# Create connection headers
-# =========================
-#
-conn_hdrs = {"accept-version" => "1.1",    # 1.1
-      "host" => virt_host,                 # vhost
-      "heart-beat" => "5000,10000",        # heartbeats
+class HeartBeatExample1
+  # Initialize.
+  def initialize
+  end
+  # Run example.
+  def run
+    # Create connection headers
+    # =========================
+    #
+    conn_hdrs = {"accept-version" => "1.1", # 1.1
+      "host" => virt_host,                  # vhost
+      "heart-beat" => "5000,10000",         # heartbeats
     }
-# Create a logger for demonstration purposes
-logger = Slogger.new
-# Connect - a paramaterized request.
-conn = Stomp::Connection.new(login, passcode, host, port,   # Normal connect parms
-  false,      # Not reliable, the default for a paramaterized connection
-  5,          # Connect redelay, the default for a paramaterized connection
-  conn_hdrs)  # The 1.1 connection parameters / headers
-puts "Connection connect complete"
-#
-raise "Unexpected protocol level" if conn.protocol != Stomp::SPL_11
-#
-conn.set_logger(logger) # Connection uses a logger
-sleep 65
-conn.set_logger(nil)    # No logging
+    # Create a logger for demonstration purposes
+    logger = Slogger.new
+    # Connect - a paramaterized request.
+    conn = Stomp::Connection.new(login, passcode, host, port,   # Normal connect parms
+      false,      # Not reliable, the default for a paramaterized connection
+      5,          # Connect redelay, the default for a paramaterized connection
+      conn_hdrs)  # The 1.1 connection parameters / headers
+    puts "Connection connect complete"
+    #
+    raise "Unexpected protocol level" if conn.protocol != Stomp::SPL_11
+    #
+    conn.set_logger(logger) # Connection uses a logger
+    sleep 65
+    conn.set_logger(nil)    # No logging
+    #
+    conn.disconnect   # Get out
+    puts "Connection disconnect complete"
+  end
+end
 #
-conn.disconnect   # Get out
-puts "Connection disconnect complete"
-
-
+e = HeartBeatExample1.new
+e.run
 

data/examples/consumer.rb

@@ -2,20 +2,33 @@
 
 require 'rubygems'
 require 'stomp'
+#
+# == Example message consumer.
+#
+class ExampleConsumer
+  # Initialize.
+  def initialize
+  end
+  # Run example.
+  def run
+  client = Stomp::Client.new("failover://(stomp://:@localhost:61613,stomp://:@remotehost:61613)?initialReconnectDelay=5000&randomize=false&useExponentialBackOff=false")
+  puts "Subscribing ronaldo"
+  client.subscribe("/queue/ronaldo", {:ack => "client", "activemq.prefetchSize" => 1, "activemq.exclusive" => true }) do |msg|
+    File.open("file", "a") do |f|
+      f.write(msg.body)
+      f.write("\n----------------\n")
+    end
 
+    client.acknowledge(msg)
+  end
 
-client = Stomp::Client.new("failover://(stomp://:@localhost:61613,stomp://:@remotehost:61613)?initialReconnectDelay=5000&randomize=false&useExponentialBackOff=false")
-puts "Subscribing ronaldo"
-client.subscribe("/queue/ronaldo", {:ack => "client", "activemq.prefetchSize" => 1, "activemq.exclusive" => true }) do |msg|
-  File.open("file", "a") do |f|
-    f.write(msg.body)
-    f.write("\n----------------\n")
+  loop do
+    sleep(1)
+    puts "."
+  end
   end
-  
-  client.acknowledge(msg)
 end
+#
+e = ExampleConsumer.new
+e.run
 
-loop do
-  sleep(1)
-  puts "."
-end

data/examples/get11conn_ex1.rb

@@ -12,98 +12,106 @@ else
 end
 include Stomp11Common
 #
-# Stomp 1.1 Receive Example 1
-# ===========================
+# == Stomp 1.1 Receive Example 1
 #
 # Purpose: to demonstrate receiving messages using Stomp 1.1.
 #
-conn = get_connection() # Use helper method to obtain a Stomp#connection
-raise "Unexpected protocol level" if conn.protocol != Stomp::SPL_11
-#
-# To start receiving messages, you must first subscribe.  This is similar
-# to using Stomp 1.0.
-#
-# However, with Stomp 1.1:
-#
-# * for subscribe, the 'id' header is now _required_
-# * for unsubscribe, the 'id' header is now _required_
-#
-# The 'id' header specifies a 'subscription id' that _must_ be unique for
-# the current session.
-#
-qname = "/queue/nodea.nodeb.nodec"
-#
-# Here is an example of allowed functionality in 1.0 that is not allowed in 1.1:
-#
-begin
-  conn.subscribe qname
-rescue RuntimeError => sre
-  puts "Rescue: #{sre}, #{sre.message}"
+class Receive11Example1
+  # Initialize.
+  def initialize
+  end
+  # Run example.
+  def run
+    conn = get_connection() # Use helper method to obtain a Stomp#connection
+    raise "Unexpected protocol level" if conn.protocol != Stomp::SPL_11
+    #
+    # To start receiving messages, you must first subscribe.  This is similar
+    # to using Stomp 1.0.
+    #
+    # However, with Stomp 1.1:
+    #
+    # * for subscribe, the 'id' header is now _required_
+    # * for unsubscribe, the 'id' header is now _required_
+    #
+    # The 'id' header specifies a 'subscription id' that _must_ be unique for
+    # the current session.
+    #
+    qname = "/queue/nodea.nodeb.nodec"
+    #
+    # Here is an example of allowed functionality in 1.0 that is not allowed in 1.1:
+    #
+    begin
+      conn.subscribe qname
+    rescue RuntimeError => sre
+      puts "Rescue: #{sre}, #{sre.message}"
+    end
+    #
+    # So, you must specify an 'id' header.  And it must be unique within the
+    # current session.
+    #
+    # You can build your own unique ids of course.  That is a valid option.
+    # In order to provide you with some assistance in generating unique ids,
+    # two convenience methods are provided with the connection:
+    #
+    # * sha1 - generate a sha1 hash of some data you supply.  This may be sufficient for many purposes.
+    # * uuid - generate a type 4 UUID.  This would be sufficient in all cases.
+    #
+    # Get a sha1:
+    #
+    sha1 = conn.sha1(qname) # sha1 of the queue name perhaps
+    puts "Queue name: #{qname}, sha1: #{sha1}"
+    #
+    # Or perhaps a different sha1:
+    #
+    tn = Time.now.to_f.to_s # Maybe unique itself.
+    sha1 = conn.sha1(tn)
+    puts "Time now: #{tn}, sha1: #{sha1}"
+    #
+    # Or a Type 4 UUID:
+    #
+    uuid = conn.uuid()
+    puts "Type 4 UUID: #{uuid}"
+    #
+    # You can specify the 'id' in the subscribe call in one of two ways:
+    #
+    # a) In the headers parameter
+    # b) In the third positional parameter, the subId
+    #
+    # So, using the 'uuid', either:
+    #
+    # a) conn.subscribe qname, {'id' => uuid}
+    # b) conn.subscribe qname, {}, uuid
+    #
+    conn.subscribe qname, {'id' => uuid} # First style
+    #
+    # Within a session, you may not subscribe to the same subscription id.
+    #
+    begin
+      conn.subscribe qname, {'id' => uuid} # Second time
+    rescue RuntimeError => sre
+      puts "Rescue: #{sre}, #{sre.message}"
+    end
+    #
+    # Once you have subscribed, you may receive as usual
+    #
+    1.upto(nmsgs()) do
+      received = conn.receive
+      puts "Received data: #{received.body}"
+    end
+    #
+    # For unsubscribe, you must use the 'id' you used on subscribe.
+    #
+    # You have the same options for placing this id in the headers or in the 3rd
+    # positional parameter.
+    #
+    conn.unsubscribe qname, {}, uuid # Second style
+    #
+    # And finally, disconnect.
+    #
+    conn.disconnect
+  end
 end
 #
-# So, you must specify an 'id' header.  And it must be unique within the
-# current session.
-#
-# You can build your own unique ids of course.  That is a valid option.
-# In order to provide you with some assistance in generating unique ids,
-# two convenience methods are provided with the connection:
-#
-# * sha1 - generate a sha1 hash of some data you supply.  This may be sufficient for many purposes.
-# * uuid - generate a type 4 UUID.  This would be sufficient in all cases.
-#
-# Get a sha1:
-#
-sha1 = conn.sha1(qname) # sha1 of the queue name perhaps
-puts "Queue name: #{qname}, sha1: #{sha1}"
-#
-# Or perhaps a different sha1:
-#
-tn = Time.now.to_f.to_s # Maybe unique itself.
-sha1 = conn.sha1(tn)
-puts "Time now: #{tn}, sha1: #{sha1}"
-#
-# Or a Type 4 UUID:
-#
-uuid = conn.uuid()
-puts "Type 4 UUID: #{uuid}"
-#
-# You can specify the 'id' in the subscribe call in one of two ways:
-#
-# a) In the headers parameter
-# b) In the third positional parameter, the subId
-#
-# So, using the 'uuid', either:
-#
-# a) conn.subscribe qname, {'id' => uuid}
-# b) conn.subscribe qname, {}, uuid
-#
-conn.subscribe qname, {'id' => uuid} # First style
-#
-# Within a session, you may not subscribe to the same subscription id.
-#
-begin
-  conn.subscribe qname, {'id' => uuid} # Second time
-rescue RuntimeError => sre
-  puts "Rescue: #{sre}, #{sre.message}"
-end
-#
-# Once you have subscribed, you may receive as usual
-#
-1.upto(nmsgs()) do
-  received = conn.receive
-  puts "Received data: #{received.body}"
-end
-#
-# For unsubscribe, you must use the 'id' you used on subscribe.
-#
-# You have the same options for placing this id in the headers or in the 3rd
-# positional parameter.
-#
-conn.unsubscribe qname, {}, uuid # Second style
-#
-# And finally, disconnect.
-#
-conn.disconnect
-
-
+e = Receive11Example1.new
+e.run
 

data/examples/get11conn_ex2.rb

@@ -12,58 +12,66 @@ else
 end
 include Stomp11Common
 #
-# Stomp 1.1 Receive Example 2
-# ===========================
+# == Stomp 1.1 Receive Example 2
 #
 # Purpose: to demonstrate receiving messages using Stomp 1.1, and using
 # 'ack => client'.
 #
-conn = get_connection() # Use helper method to obtain a Stomp#connection
-raise "Unexpected protocol level" if conn.protocol != Stomp::SPL_11
-#
-qname = "/queue/nodea.nodeb.nodec"
-#
-uuid = conn.uuid()
-puts "Subscribe id: #{uuid}"
-#
-# Subscribe with client ack mode
-#
-conn.subscribe qname, {'id' => uuid, 'ack' => 'client'} #
-#
-# Once you have subscribed, you may receive as usual
-#
-1.upto(nmsgs()) do
-  received = conn.receive
-  puts "Received data: #{received.body}"
-  #
-  # We want now to ACK this message.  In Stomp 1.0, a 'message-id' header was 
-  # required for the ACK.  In Stomp 1.1, and additional header is required:
-  #
-  # * 'subscription' => id
-  #
-  msgid = received.headers['message-id']
-  #
-  # What you cannot do:
-  #
-  begin
-    conn.ack msgid
-  rescue RuntimeError => sre
-    puts "Rescue: #{sre}, #{sre.message}"
+class Receive11Example2
+  # Initialize.
+  def initialize
+  end
+  # Run example.
+  def run
+    conn = get_connection() # Use helper method to obtain a Stomp#connection
+    raise "Unexpected protocol level" if conn.protocol != Stomp::SPL_11
+    #
+    qname = "/queue/nodea.nodeb.nodec"
+    #
+    uuid = conn.uuid()
+    puts "Subscribe id: #{uuid}"
+    #
+    # Subscribe with client ack mode
+    #
+    conn.subscribe qname, {'id' => uuid, 'ack' => 'client'} #
+    #
+    # Once you have subscribed, you may receive as usual
+    #
+    1.upto(nmsgs()) do
+      received = conn.receive
+      puts "Received data: #{received.body}"
+      #
+      # We want now to ACK this message.  In Stomp 1.0, a 'message-id' header was
+      # required for the ACK.  In Stomp 1.1, and additional header is required:
+      #
+      # * 'subscription' => id
+      #
+      msgid = received.headers['message-id']
+      #
+      # What you cannot do:
+      #
+      begin
+        conn.ack msgid
+      rescue RuntimeError => sre
+        puts "Rescue: #{sre}, #{sre.message}"
+      end
+      #
+      # Try a valid 1.1 ACK
+      #
+      conn.ack msgid, {'subscription' => uuid}
+      puts "ACK - msgid: #{msgid}, subscription: #{uuid}"
+    end
+    #
+    # Unsubscribe
+    #
+    conn.unsubscribe qname, {}, uuid # Second style
+    #
+    # And finally, disconnect.
+    #
+    conn.disconnect
   end
-  #
-  # Try a valid 1.1 ACK
-  #
-  conn.ack msgid, {'subscription' => uuid}
-  puts "ACK - msgid: #{msgid}, subscription: #{uuid}"
 end
 #
-# Unsubscribe
-#
-conn.unsubscribe qname, {}, uuid # Second style
-#
-# And finally, disconnect.
-#
-conn.disconnect
-
-
+e = Receive11Example2.new
+e.run