stomp 1.4.4 → 1.4.5

data/examples/conn11_ex2.rb

@@ -1,87 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-#
-# The current require dance for different Ruby versions.
-# Change this to suit your requirements.
-#
-if Kernel.respond_to?(:require_relative)
-  require_relative("./stomp11_common")
-else
-  $LOAD_PATH << File.dirname(__FILE__)
-  require "stomp11_common"
-end
-include Stomp11Common
-
-#
-# == 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.
-#
-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},
-      ],
-      :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
-#
-e = Connection11Example2.new
-e.run
-

data/examples/conn11_hb1.rb

@@ -1,57 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-#
-# The current require dance for different Ruby versions.
-# Change this to suit your requirements.
-#
-if Kernel.respond_to?(:require_relative)
-  require_relative("./stomp11_common")
-  require_relative("./examplogger")
-else
-  $LOAD_PATH << File.dirname(__FILE__)
-  require "stomp11_common"
-  require "examplogger"
-end
-include Stomp11Common
-
-#
-# == Stomp 1.1 Heartbeat Example 1
-#
-# Purpose: to demonstrate that heart beats can work.
-#
-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
-    #
-    conn.disconnect   # Get out
-    puts "Connection disconnect complete"
-  end
-end
-#
-e = HeartBeatExample1.new
-e.run
-

data/examples/consume_file.rb

@@ -1,63 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-require 'rubygems'
-require 'stomp'
-
-if Kernel.respond_to?(:require_relative)
-  require_relative("./stomp11_common")
-  require_relative("./lflogger")
-else
-  $LOAD_PATH << File.dirname(__FILE__)
-  require "stomp11_common"
-  require "./lflogger"
-end
-include Stomp11Common
-#
-# Used primarily for testing performance when receiving "large" messages.
-# "large" => YMMV
-#
-class FileReader
-  # Initialize.
-  def initialize(pto)
-    @parse_timeout = pto
-  end
-  # Run example.
-  def run
-    conlogger = Slogger::new
-    start_time = Time.now.to_f
-    #
-    connection_hdrs = {"accept-version" => "1.1",
-      "host" => virt_host(),
-    }
-    connection_hash = { :hosts => [
-        {:login => login(), :passcode => passcode(),
-          :host => host(), :port => port()},
-      ],
-      :connect_headers => connection_hdrs,
-      :logger => conlogger,
-      :reliable => false,
-      :parse_timeout => @parse_timeout,
-    }
-    #
-    # p [ "ch", connection_hash ]
-    connection = Stomp::Connection.new(connection_hash)
-    qname = ENV['STOMP_DEST'] ? ENV['STOMP_DEST'] : "/queue/a.big.file"
-    puts "CONF: Qname is: #{qname}"
-    ## connection.subscribe(qname, {:destination => qname}, "bigFileSubscriptionID")
-    connection.subscribe(qname, {:destination => qname}, connection.uuid())
-    ## connection.subscribe(qname, {:destination => qname}, "0")
-    msg = connection.receive()
-    puts "CONF: Message Command: #{msg.command}"
-    puts "CONF: Message Headers: #{msg.headers}"
-    body_length_bytes = msg.body.respond_to?(:bytesize) ? msg.body.bytesize : msg.body.length
-    puts "CONF: Received: #{body_length_bytes} bytes"
-    connection.disconnect
-    end_time = Time.now.to_f
-    ppt = sprintf("%20.6f", end_time - start_time)
-    puts "CONF: File consumed: #{ppt} seconds"
-  end
-end
-#
-e = FileReader.new(60)
-e.run
-

data/examples/get11conn_ex1.rb

@@ -1,117 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-#
-# The current require dance for different Ruby versions.
-# Change this to suit your requirements.
-#
-if Kernel.respond_to?(:require_relative)
-  require_relative("./stomp11_common")
-else
-  $LOAD_PATH << File.dirname(__FILE__)
-  require "stomp11_common"
-end
-include Stomp11Common
-#
-# == Stomp 1.1 Receive Example 1
-#
-# Purpose: to demonstrate receiving messages using Stomp 1.1.
-#
-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
-#
-e = Receive11Example1.new
-e.run
-

data/examples/get11conn_ex2.rb

@@ -1,77 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-#
-# The current require dance for different Ruby versions.
-# Change this to suit your requirements.
-#
-if Kernel.respond_to?(:require_relative)
-  require_relative("./stomp11_common")
-else
-  $LOAD_PATH << File.dirname(__FILE__)
-  require "stomp11_common"
-end
-include Stomp11Common
-#
-# == Stomp 1.1 Receive Example 2
-#
-# Purpose: to demonstrate receiving messages using Stomp 1.1, and using
-# 'ack => client'.
-#
-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
-end
-#
-e = Receive11Example2.new
-e.run
-

data/examples/lflogger.rb

@@ -1,316 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-require 'logger'	# use the standard Ruby logger .....
-
-# == Example STOMP call back logger class.
-#
-# Optional callback methods:
-#
-# *    on_connecting: connection starting
-# *    on_connected: successful connect
-# *    on_connectfail: unsuccessful connect (will usually be retried)
-# *    on_disconnect: successful disconnect
-#
-# *    on_miscerr: on miscellaneous xmit/recv errors
-#
-# *    on_publish: publish called
-# *    on_subscribe: subscribe called
-# *    on_unsubscribe: unsubscribe called
-#
-# *    on_begin: begin called
-# *    on_ack: ack called
-# *    on_nack: nack called
-# *    on_commit: commit called
-# *    on_abort: abort called
-#
-# *    on_receive: receive called and successful
-#
-# *    on_ssl_connecting: SSL connection starting
-# *    on_ssl_connected: successful SSL connect
-# *    on_ssl_connectfail: unsuccessful SSL connect (will usually be retried)
-#
-# *    on_hbread_fail: unsuccessful Heartbeat read
-# *    on_hbwrite_fail: unsuccessful Heartbeat write
-# *    on_hbfire: on any send or receive heartbeat
-#
-# All methods are optional, at the user's requirements.
-#
-# If a method is not provided, it is not called (of course.)
-# 
-# IMPORTANT NOTE:  in general, call back logging methods *SHOULD* not raise exceptions, 
-# otherwise the underlying STOMP connection may fail in mysterious ways.
-# There are, however, exceptions to this 'rule'.
-#
-# Useful exceptions to this rule are:
-#
-# *    on_connectfail
-# *    on_ssl_connectfail
-#
-# These two methods can raise a Stomp::Errors::LoggerConnectionError.  If this
-# exception is raised, it is passed up the chain to the caller.
-#
-# Callback parameters: are a copy of the @parameters instance variable for
-# the Stomp::Connection.
-#
-# A logger class may optionally inherit from the provided NullLogger
-#
-# # class Slogger < Stomp::NullLogger
-#
-class Slogger
-
-  MAX_BODY_LEN = 1024 # Arbitrary
-
-  # Initialize a new callback logger instance.
-  def initialize(init_parms = nil)
-    _init
-    @log.info("Logger initialization complete.")
-  end
-
-  def _init
-    @log = Logger::new(STDOUT)		# User preference
-    @log.level = Logger::DEBUG		# User preference
-  end
-
-  def marshal_dump
-    []
-  end
-
-  def marshal_load(array)
-    _init
-  end
-
-  # Log connecting events
-  def on_connecting(parms)
-    begin
-      @log.debug "Connecting: #{info(parms)}"
-    rescue
-      @log.debug "Connecting oops #{$!}"
-    end
-  end
-
-  # Log connected events
-  def on_connected(parms)
-    begin
-      @log.debug "Connected Info: #{info(parms)}"
-      @log.debug "Connected Parms: #{parms}"
-    rescue
-      @log.debug "Connected oops #{$!}"
-    end
-  end
-
-  # Log connectfail events
-  def on_connectfail(parms)
-    begin
-      @log.debug "Connect Fail #{info(parms)}"
-    rescue
-      @log.debug "Connect Fail oops #{$!}"
-    end
-=begin
-    # An example LoggerConnectionError raise
-    @log.debug "Connect Fail, will raise"
-    raise Stomp::Error::LoggerConnectionError.new("quit from connect fail")
-=end
-  end
-
-  # Log disconnect events
-  def on_disconnect(parms)
-    begin
-      @log.debug "Disconnected #{info(parms)}"
-    rescue
-      @log.debug "Disconnected oops #{$!}"
-    end
-  end
-
-  # Log miscellaneous errors
-  def on_miscerr(parms, errstr)
-    begin
-      @log.debug "Miscellaneous Error Info: #{info(parms)}"
-      @log.debug "Miscellaneous Error String: #{errstr}"
-      @log.debug "Miscellaneous Error Parms: #{parms}"
-    rescue
-      @log.debug "Miscellaneous Error oops #{$!}"
-      # Most clients will want to know about this. YMMV
-      raise
-    end
-  end
-
-  # Log Subscribe
-  def on_subscribe(parms, headers)
-    begin
-      @log.debug "Subscribe Parms #{info(parms)}"
-      @log.debug "Subscribe Headers #{headers}"
-    rescue
-      @log.debug "Subscribe oops #{$!}"
-    end
-  end
-
-  # Log UnSubscribe
-  def on_unsubscribe(parms, headers)
-    begin
-      @log.debug "UnSubscribe Parms #{info(parms)}"
-      @log.debug "UnSubscribe Headers #{headers}"
-    rescue
-      @log.debug "UnSubscribe oops #{$!}"
-    end
-  end
-
-  # Log Publish
-  def on_publish(parms, body, headers)
-    begin
-      @log.debug "Publish Parms #{info(parms)}"
-      body_length_bytes = body.respond_to?(:bytesize) ? body.bytesize : body.length
-      @log.debug "Publish Message Body #{body}" if body_length_bytes <= MAX_BODY_LEN
-      @log.debug "Publish Headers #{headers}"
-    rescue
-      @log.debug "Publish oops #{$!}"
-    end
-  end
-
-  # Log Receive
-  def on_receive(parms, result)
-    begin
-      @log.debug "Receive Parms #{info(parms)}"
-      @log.debug result.is_a? Stomp::Message
-      ## @log.debug "Receive Result #{result}"
-    rescue
-      @log.debug "Receive oops #{$!}"
-    end
-  end
-
-  # Log Begin
-  def on_begin(parms, headers)
-    begin
-      @log.debug "Begin Parms #{info(parms)}"
-      @log.debug "Begin Result #{headers}"
-    rescue
-      @log.debug "Begin oops #{$!}"
-    end
-  end
-
-  # Log Ack
-  def on_ack(parms, headers)
-    begin
-      @log.debug "Ack Parms #{info(parms)}"
-      @log.debug "Ack Result #{headers}"
-    rescue
-      @log.debug "Ack oops #{$!}"
-    end
-  end
-
-  # Log NAck
-  def on_nack(parms, headers)
-    begin
-      @log.debug "NAck Parms #{info(parms)}"
-      @log.debug "NAck Result #{headers}"
-    rescue
-      @log.debug "NAck oops #{$!}"
-    end
-  end
-
-  # Log Commit
-  def on_commit(parms, headers)
-    begin
-      @log.debug "Commit Parms #{info(parms)}"
-      @log.debug "Commit Result #{headers}"
-    rescue
-      @log.debug "Commit oops #{$!}"
-    end
-  end
-
-  # Log Abort
-  def on_abort(parms, headers)
-    begin
-      @log.debug "Abort Parms #{info(parms)}"
-      @log.debug "Abort Result #{headers}"
-    rescue
-      @log.debug "Abort oops #{$!}"
-    end
-  end
-
-  # Stomp 1.1+ - heart beat read (receive) failed.
-  def on_hbread_fail(parms, ticker_data = {})
-    begin
-      @log.debug "Hbreadf Parms #{info(parms)}"
-      @log.debug "Hbreadf Result #{ticker_data.inspect}"
-    rescue
-      @log.debug "Hbreadf oops #{$!}"
-    end
-  end
-
-  # Stomp 1.1+ - heart beat send (transmit) failed.
-  def on_hbwrite_fail(parms, ticker_data = {})
-    begin
-      @log.debug "Hbwritef Parms #{info(parms)}"
-      @log.debug "Hbwritef Result #{ticker_data.inspect}"
-    rescue
-      @log.debug "Hbwritef oops #{$!}"
-    end
-  end
-
-  # Log SSL connection start.
-  def on_ssl_connecting(parms)
-    begin
-      @log.debug "SSL Connecting Parms #{info(parms)}"
-    rescue
-      @log.debug "SSL Connecting oops #{$!}"
-    end
-  end
-
-  # Log a successful SSL connect.
-  def on_ssl_connected(parms)
-    begin
-      @log.debug "SSL Connected Parms #{info(parms)}"
-    rescue
-      @log.debug "SSL Connected oops #{$!}"
-    end
-  end
-
-  # Log an unsuccessful SSL connect.
-  def on_ssl_connectfail(parms)
-    begin
-      @log.debug "SSL Connect Fail Parms #{info(parms)}"
-      @log.debug "SSL Connect Fail Exception #{parms[:ssl_exception]}, #{parms[:ssl_exception].message}"
-    rescue
-      @log.debug "SSL Connect Fail oops #{$!}"
-    end
-=begin
-    # An example LoggerConnectionError raise
-    @log.debug "SSL Connect Fail, will raise"
-    raise Stomp::Error::LoggerConnectionError.new("quit from SSL connect")
-=end
-  end
-
-  # Log heart beat fires
-  def on_hbfire(parms, srind, firedata = {})
-    begin
-      @log.debug "HeartBeat Fire Parms #{info(parms)}"
-      @log.debug "HeartBeat Fire Send/Receive #{srind}"
-    rescue
-      @log.debug "HeartBeat Fire oops #{$!}"
-    end
-  end
-
-  private
-
-  # Example information extract.
-  def info(parms)
-    #
-    # Available in the parms Hash:
-    # parms[:cur_host]
-    # parms[:cur_port]
-    # parms[:cur_login]
-    # parms[:cur_passcode]
-    # parms[:cur_ssl]
-    # parms[:cur_recondelay]
-    # parms[:cur_parseto]
-    # parms[:cur_conattempts]
-    # parms[:cur_failure]
-    # parms[:openstat]
-    #
-    # For the on_ssl_connectfail callback these are also available:
-    # parms[:ssl_exception]
-    #
-    "Host: #{parms[:cur_host]}, Port: #{parms[:cur_port]}, Login: #{parms[:cur_login]}, Passcode: #{parms[:cur_passcode]}, ssl: #{parms[:cur_ssl]}"
-  end
-end # of class
-