oml4r 2.8.0 → 2.9.pre.151.f020

data/lib/oml4r.rb

@@ -32,6 +32,7 @@
 require 'socket'
 require 'monitor'
 require 'thread'
+require 'optparse'
 
 #
 # This is the OML4R module, which should be required by ruby applications
@@ -39,11 +40,15 @@ require 'thread'
 #
 module OML4R
 
-  VERSION = "2.8.0"
-  REVISION = "$Revision: 1 $".split(":")[1].chomp("$").strip
-  VERSION_STRING = "OML4R Client Library - Version #{VERSION} (#{REVISION})"
+  VERSION = "2.9.pre.151.f020"
+  VERSION_STRING = "OML4R Client V#{VERSION}"
+  COPYRIGHT = "Copyright 2009-2012, NICTA"
   DEF_SERVER_PORT = 3003
 
+  PROTOCOL = 3
+  @loglevel = 0
+  class << self; attr_accessor :loglevel; end
+
   #
   # Measurement Point Class
   # Ruby applications using this module should sub-class this MPBase class
@@ -101,7 +106,7 @@ module OML4R
       o[:name] = name
       o[:type] ||= :string
       if o[:type] == :long
-	$stderr.puts "OML4R: WARN: :long is deprecated use, :int32 instead"
+	$stderr.puts "WARN	:long is deprecated use, :int32 instead"
 	o[:type] = :int32
       end
       __def__()[:p_def] << o
@@ -152,12 +157,12 @@ module OML4R
       # replace channel names with channel object
       self.each_mp do |klass, defs|
 	cna = @@channels[klass] || []
-	#$stderr.puts "OML4R: '#{cna.inspect}', '#{klass}'"
+	$stderr.puts "DEBUG	'#{cna.inspect}', '#{klass}'" if OML4R.loglevel > 0
 	ca = cna.collect do |cname, domain|
 	  # return it in an array as we need to add the channel specific index  
 	  [Channel[cname.to_sym, domain.to_sym]]
 	end
-	#$stderr.puts "OML4R: Using channels '#{ca.inspect}"
+	$stderr.puts "DEBUG	Using channels '#{ca.inspect}" if OML4R.loglevel > 0
 	@@channels[klass] = ca.empty? ? [[Channel[]]] : ca
       end
       @@start_time = start_time
@@ -188,7 +193,7 @@ module OML4R
       end
 
       @@channels[self].each do |ca|
-	#$stderr.puts "OML4R: Setting up channel '#{ca.inspect}"
+	$stderr.puts "DEBUG	Setting up channel '#{ca.inspect}" if OML4R.loglevel > 0
 	index = ca[0].send_schema(mp_name, defs[:p_def])
 	ca << index
       end
@@ -210,11 +215,12 @@ module OML4R
   # - & block = a block which defines the additional application-specific arguments
   #
   def self.init(argv, opts = {}, &block)
+    $stderr.puts("INFO	#{VERSION_STRING} [Protocol V#{PROTOCOL}] #{COPYRIGHT}")
 
     if d = (ENV['OML_EXP_ID'] || opts[:expID])
       # XXX: It is still too early to complain about that. We need to be sure
       # of the nomenclature before making user-visible changes.
-      #$stderr.puts "OML4R: WARN: ENV['OML_EXP_ID'] and opts[:expID] are deprecated, use #DOMAIN or opts[:domain] instead"
+      $stderr.puts "WARN	opts[:expID] and ENV['OML_EXP_ID'] are getting deprecated; please use opts[:domain] or ENV['OML_DOMAIN']  instead"
       opts[:domain] ||= d
     end
     domain ||= ENV['OML_DOMAIN'] || opts[:domain]
@@ -233,24 +239,37 @@ module OML4R
     appName = opts[:appName] || opts[:app]
 
     if  ENV['OML_URL'] || opts[:omlURL] || opts[:url]
-      raise 'OML4R: neither OML_URL, :omlURL nor :url are valid. Do you mean OML_SERVER or :omlServer?'
+      raise 'ERROR	neither OML_URL, :omlURL nor :url are valid. Do you mean OML_COLLECT or :omlCollect?'
+    end
+    if ENV['OML_SERVER'] || opts[:omlServer]
+	$stderr.puts "WARN	opts[:omlServer] and ENV['OML_SERVER'] are getting deprecated; please use opts[:collect] or ENV['OML_COLLECT'] instead"
     end
-    omlCollectUri = ENV['OML_SERVER'] || opts[:omlServer]
+    omlCollectUri = ENV['OML_COLLECT'] || ENV['OML_SERVER'] || opts[:collect] || opts[:omlServer]
     noop = opts[:noop] || false
 
 
     # Create a new Parser for the command line
-    require 'optparse'
     op = OptionParser.new
     # Include the definition of application's specific arguments
     yield(op) if block
     # Include the definition of OML specific arguments
-    op.on("--oml-file file", "Writes measurements to 'file'") { |name| omlCollectUri = "file:#{name}" }
     op.on("--oml-id id", "Name to identify this app instance [#{nodeID || 'undefined'}]") { |name| nodeID = name }
-    op.on("--oml-exp-id expId", "Name to experiment DB [#{domain || 'undefined'}]") { |name| domain = name }
-    op.on("--oml-domain expId", "Name to experiment DB [#{domain || 'undefined'}] *EXPERIMENTAL*") { |name| domain = name }
-    op.on("--oml-server uri", "URI of server to send measurements to (tcp:host:port)") { |u|  omlCollectUri = u }
+    op.on("--oml-domain domain", "Name of experimental domain [#{domain || 'undefined'}] *EXPERIMENTAL*") { |name| domain = name }
+    op.on("--oml-collect uri", "URI of server to send measurements to") { |u|  omlCollectUri = u }
+    op.on("--oml-log-level l", "Log level used (info: 0 .. debug: 1)") { |l| OML4R.loglevel = l.to_i; puts "-> #{OML4R.loglevel}" }    
     op.on("--oml-noop", "Do not collect measurements") { noop = true }    
+    op.on("--oml-exp-id domain", "Obsolescent equivalent to --oml-domain domain") { |name|
+      domain = name
+      $stderr.puts "WARN	Option --oml-exp-id is getting deprecated; please use '--oml-domain #{domain}' instead"
+    }
+    op.on("--oml-file localPath", "Obsolescent equivalent to --oml-collect file:localPath") { |name|
+      omlCollectUri = "file:#{name}"
+      $stderr.puts "WARN	Option --oml-file is getting deprecated; please use '--oml-collect #{omlCollectUri}' instead"
+    }
+    op.on("--oml-server uri", "Obsolescent equivalent to --oml-collect uri") {|u|
+      omlCollectUri = u
+      $stderr.puts "WARN	Option --oml-server is getting deprecated; please use '--oml-collect #{omlCollectUri}' instead"
+    }
     op.on_tail("--oml-help", "Show this message") { $stderr.puts op; exit }
     # XXX: This should be set by the application writer, not the command line
     #op.on("--oml-appid APPID", "Application ID for OML [#{appName || 'undefined'}] *EXPERIMENTAL*") { |name| appID = name }
@@ -259,12 +278,12 @@ module OML4R
     omlCollectUri ||= "file:#{appName}_#{nodeID}_#{domain}_#{Time.now.strftime("%Y-%m-%dt%H.%M.%S%z")}"
 
     # Now parse the command line
-    #$stderr.puts "OML4R: ARGV:>>> #{argv.inspect}"
+    $stderr.puts "DEBUG	ARGV:>>> #{argv.inspect}" if OML4R.loglevel > 0
     rest = op.parse(argv)
     return if noop
 
     unless domain && nodeID && appName
-      raise 'OML4R: Missing values for parameters :expID (--oml-exp-id), :nodeID (--oml-id), or :appName (in code)!'
+      raise 'OML4R: Missing values for parameters :domain (--oml-domain), :nodeID (--oml-id), or :appName (in code)!'
     end
 
     Channel.create(:default, omlCollectUri) if omlCollectUri
@@ -272,8 +291,8 @@ module OML4R
     # Handle the defined Measurement Points
     startTime = Time.now
     Channel.init_all(domain, nodeID, appName, startTime)
-    msg = "OML4R enabled."
-    Object.const_defined?(:MObject) ? MObject.debug(:oml4r, msg) : $stderr.puts("OML4R: #{msg}")
+    msg = "Collection URI is #{omlCollectUri}"
+    Object.const_defined?(:MObject) ? MObject.debug(:oml4r, msg) : $stderr.puts("INFO	#{msg}")
 
     rest || []
   end
@@ -309,7 +328,7 @@ module OML4R
     end
 
     def self._create(key, domain, url)
-      #oml_opts = {:exp_id => 'image_load', :node_id => 'n1', :app_name => 'img_load'}
+      #oml_opts = {:domain => 'image_load', :node_id => 'n1', :app_name => 'img_load'}
       if url.start_with? 'file:'
 	proto, fname = url.split(':')
 	out = (fname == '-' ? $stdout : File.open(fname, "w+"))
@@ -403,9 +422,12 @@ module OML4R
 
 
     def send_protocol_header(nodeID, appName, startTime)
-      @queue.push "protocol: 1"
+      @queue.push "protocol: #{PROTOCOL}"
       d = (@domain == :default) ? @@default_domain : @domain
       raise "Missing domain name" unless d
+      # Protocol V4
+      #@queue.push "domain: #{d}"
+      #@queue.push "start-time: #{startTime.tv_sec}"
       @queue.push "experiment-id: #{d}"
       @queue.push "start_time: #{startTime.tv_sec}"
       @queue.push "sender-id: #{nodeID}"
@@ -438,7 +460,7 @@ module OML4R
 	  @out = nil
 	rescue Exception => ex
 	  msg = "Exception while sending message to channel '#{@url}' (#{ex})"
-	  Object.const_defined?(:MObject) ? MObject.warn(:oml4r, msg) : $stderr.puts("OML4R: #{msg}")
+	  Object.const_defined?(:MObject) ? MObject.warn(:oml4r, msg) : $stderr.puts("INFO	#{msg}")
 	end
       end
     end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: oml4r
 version: !ruby/object:Gem::Version
-  version: 2.8.0
-  prerelease: 
+  version: 2.9.pre.151.f020
+  prerelease: 4
 platform: ruby
 authors:
 - NICTA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-25 00:00:00.000000000 Z
+date: 2012-10-04 00:00:00.000000000 Z
 dependencies: []
 description: ! '["Simple OML client library for Ruby"]'
 email:
@@ -42,9 +42,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23