oml4r 2.9.pre.151.f020 → 2.9.0

data/README.md

@@ -1,44 +1,52 @@
-# OML4R
+OML4R: Native OML Implementation in Ruby			{#oml4rdoc}
+========================================
 
 This is a simple client library for OML which does not use liboml2 and its
-filters, but connects directly to the server using the text protocol.
+filters, but connects directly to the server using the text protocol [oml-text].
 User can use this library to create ruby applications which can send
 measurement to the OML collection server. A simple example on how to use
 this library is attached at the end of this file. Another example can be
 found in the file oml4r-example.rb
 
-## Installation
+Installation
+------------
+
+OML4R is available from RubyGems [oml4r-rubygem].
 
     $ gem install oml4r
 
-## Usage
 
-### Definition of a Measurement Point
+Usage
+-----
 
-	class MyMP < OML4R::MPBase
-	  name :mymp
+### Definition of a Measurement Point
 
-	  param :mystring
-	  param :myint, :type => :int32
-	  param :mydouble, :type => :double
-	end
+    class MyMP < OML4R::MPBase
+      name :mymp
+    
+      param :mystring
+      param :myint, :type => :int32
+      param :mydouble, :type => :double
+    end
 
 ### Initialisation, Injection and Tear-down
 
-	OML4R::init(ARGV, {
-		:appName => 'oml4rSimpleExample',
-		:expID => 'foo',
-		:nodeId => 'n1',
-		:omlServer => 'file:-'}
-	)
-	MyMP.inject("hello", 13, 37.)
-	OML4R::close()
+    OML4R::init(ARGV, {
+    	:appName => 'oml4rSimpleExample',
+    	:expID => 'foo',
+    	:nodeID => 'n1',
+    	:omlServer => 'file:-'}
+    )
+    MyMP.inject("hello", 13, 37.)
+    OML4R::close()
 
 ### Real example
 
 See examples files oml4r-simple-example.rb and oml4r-wlanconfig.rb.
 
-## License
+
+License
+-------
 
 Copyright 2009-2012 National ICT Australia (NICTA), Australia
 
@@ -60,3 +68,5 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 
+[oml-text]: http://oml.mytestbed.net/projects/oml/wiki/Description_of_Text_protocol
+[oml4r-rubygem]: https://rubygems.org/gems/oml4r/

data/lib/oml4r.rb

@@ -40,7 +40,7 @@ require 'optparse'
 #
 module OML4R
 
-  VERSION = "2.9.pre.151.f020"
+  VERSION = "2.9.0"
   VERSION_STRING = "OML4R Client V#{VERSION}"
   COPYRIGHT = "Copyright 2009-2012, NICTA"
   DEF_SERVER_PORT = 3003
@@ -328,7 +328,11 @@ module OML4R
     end
 
     def self._create(key, domain, url)
-      #oml_opts = {:domain => 'image_load', :node_id => 'n1', :app_name => 'img_load'}
+      out = _connect(url)
+      @@channels[key] = self.new(url, domain, out)
+    end
+    
+    def self._connect(url)
       if url.start_with? 'file:'
 	proto, fname = url.split(':')
 	out = (fname == '-' ? $stdout : File.open(fname, "w+"))
@@ -340,8 +344,7 @@ module OML4R
       else
 	raise "OML4R: Unknown transport in server url '#{url}'"
       end
-      #$stderr.puts "Created channel for '#{key}'"
-      @@channels[key] = self.new(url, domain, out)
+      out
     end
 
     def self.[](name = :default, domain = :default)
@@ -371,9 +374,6 @@ module OML4R
 	klass.__print_meta__(appName)
       end
 
-      # add empty line to separate header form MP channel
-      @@channels.values.each { |c| c.send "\n" }
-
       MPBase.__useOML__()
     end
 
@@ -393,7 +393,7 @@ module OML4R
 	line << "#{d[:name]}:#{d[:type]}"
       end
       msg = line.join(' ')
-      send msg
+      @header << msg
       @index
     end
 
@@ -416,26 +416,26 @@ module OML4R
       @url = url
       @out = out_channel
       @index = 0
+      @header = []
+      @header_sent = false      
       @queue = Queue.new
       start_runner
     end
 
 
     def send_protocol_header(nodeID, appName, startTime)
-      @queue.push "protocol: #{PROTOCOL}"
+      @header << "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}"
-      @queue.push "app-name: #{appName}"
-      @queue.push "content: text"
+      @header << "experiment-id: #{d}"
+      @header << "start_time: #{startTime.tv_sec}"
+      @header << "sender-id: #{nodeID}"
+      @header << "app-name: #{appName}"
+      @header << "content: text"
     end
 
     def start_runner
+      header_sent = false
       @runner = Thread.new do
 	active = true
 	begin
@@ -453,15 +453,51 @@ module OML4R
 	      msg = ma.join("\n")
 	    end
 	    #$stderr.puts ">>>>>>#{@domain}: <#{msg}>"
-	    @out.puts msg unless msg.nil?
-	    @out.flush
+            unless msg.nil?
+              _send msg 
+            end
 	  end
+          puts ">> CLOSE"
 	  @out.close
 	  @out = nil
 	rescue Exception => ex
-	  msg = "Exception while sending message to channel '#{@url}' (#{ex})"
+          msg = "Exception while sending message to channel '#{@url}' (#{ex.class})"
 	  Object.const_defined?(:MObject) ? MObject.warn(:oml4r, msg) : $stderr.puts("INFO	#{msg}")
 	end
+        info "Channel #{url} closed"
+      end
+    end
+    
+    def info(msg)
+      Object.const_defined?(:MObject) ? MObject.warn(:oml4r, msg) : $stderr.puts("INFO        #{msg}")
+    end
+    
+    def _send(msg)
+      begin
+        unless @header_sent
+          h = "#{@header.join("\n")}\n\n"
+          puts "'#{h}'"
+          @out.puts h
+          @header_sent = true
+        end
+        @out.puts msg 
+        @out.flush
+
+      rescue Errno::EPIPE
+        # Trying to reconnect
+        info "Trying to reconnect to '#{@url}'"
+        loop do 
+          sleep 5
+          begin
+            @out = self.class._connect(@url)
+            @header_sent = false
+            info "Reconnected to '#{@url}'"            
+            return _send(msg)
+          rescue Errno::ECONNREFUSED => ex
+            info "Exception while reconnect '#{@url}' (#{ex.class})"
+          end
+          #Errno::ECONNREFUSED
+        end
       end
     end
 

data/oml4r.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "oml4r"
+  gem.license	    = "MIT"
   gem.require_paths = ["lib"]
   gem.version       = OML4R::VERSION
 

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: oml4r
 version: !ruby/object:Gem::Version
-  version: 2.9.pre.151.f020
-  prerelease: 4
+  version: 2.9.0
+  prerelease: 
 platform: ruby
 authors:
 - NICTA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-04 00:00:00.000000000 Z
+date: 2012-12-10 00:00:00.000000000 Z
 dependencies: []
 description: ! '["Simple OML client library for Ruby"]'
 email:
@@ -28,7 +28,8 @@ files:
 - lib/oml4r/oml4r-wlanconfig.rb
 - oml4r.gemspec
 homepage: http://oml.mytestbed.net
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -42,9 +43,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23