wise_omf 0.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2c646960c311267d13f375733a6e9eeb8445d892
+  data.tar.gz: 987108e23efaa45458ad3cafd5f908e63f24b192
+SHA512:
+  metadata.gz: c877157e684d0d8603af76c98ff868f7eebefd34e033e39750c6005dd79dc5b15e3831bdea753728edfb6de4bb093b1ee0c9fd25f05c2da549384cd7b5021c8e
+  data.tar.gz: 3efdae6ecfc627219897d5f9210706ff0f2fb8485c59dc2d59da8b0eae424bc25c07a4a474ebcce8b19ca599cb3ef75fd5bc8a3d6b978780df39612951acf4b1

data/lib/wise_omf/client.rb

@@ -0,0 +1,211 @@
+require 'lrucache'
+require 'wise_omf/uid_helper'
+require 'yaml'
+module WiseOMF
+  module Client
+    class ExperimentHelper
+      @@random = Random.new
+      @@uid_cache = LRUCache.new(ttl: 30.minutes)
+
+
+      # Create an unique message id
+      # NOTE: Message ids are guaranteed to be unique within 30 minutes.
+      def self.messageUID
+        uid = -1
+        while true
+          uid = @@random.rand(2**32)
+          break if @@uid_cache.fetch(uid).nil?
+        end
+        @@uid_cache.store(uid, 1)
+        return uid
+      end
+
+    end
+
+    # The WiseGroup is the representation of an omf resource group
+    # which provides the ability to register callback for requests and configure messages.
+    # You should not create an instance of this group directly. This can cause unwanted side effects.
+    # The better way is to ask the ReservationManager (factory) for a group for a list of node urns.
+    class WiseGroup
+      # Message types to call callbacks for
+      @@default_message_types = [:response, :inform]
+      attr_accessor :name, :uid, :group, :default_callback
+      @callback_cache
+      @name
+      @uid
+      @group
+      @default_callback
+
+      def initialize(name, uid)
+        @callback_cache = LRUCache.new(ttl: 30.minutes)
+        @name = name
+        @uid = uid
+        group = OmfEc::Group.new(name)
+        OmfEc.experiment.add_group(group)
+        group.add_resource(uid)
+        @group = group
+
+        #@group = OmfEc::Group.new(uid, {unique: false}) { |g|
+        #  info "Created Group #{name}: #{g.to_yaml}"
+        #
+        #  #yield self unless block.nil?
+        #
+        #}
+        #OmfEc.experiment.add_group(@group)
+        #@group.add_resource(name)
+        warn "Finished init"
+      end
+
+      def init_callback
+
+        while @group.topic.nil?
+          info "Delaying callback creation for 0.5 seconds"
+          sleep 0.5
+        end
+        info "Setting message callback for #{self.name}"
+        @group.topic.on_message(:inform_status) { |msg|
+          rid = msg.content.properties.requestId
+          if rid.nil? && @@default_message_types.include?(msg.content.type)
+            self.default_callback.call(msg) unless self.default_callback.nil?
+          else
+            callback = @callback_cache.fetch(rid)
+            unless callback.nil?
+              callback.call(msg.content.properties)
+            else
+              if @@default_message_types.include? msg.content.type
+                self.default_callback.call(msg) unless self.default_callback.nil?
+              end
+            end
+          end
+        }
+
+      end
+
+      def request(property, &block)
+        mid = WiseOMF::Client::ExperimentHelper.messageUID
+        unless block.nil?
+          @callback_cache.store(mid, block)
+        end
+        fail "Can't request topic here" if property.to_sym.eql? 'topic'.to_sym
+        @group.topic.configure({property => mid})
+      end
+
+      def configure(property, value, &block)
+        mid = WiseOMF::Client::ExperimentHelper.messageUID
+        unless block.nil?
+          @callback_cache.store(mid, block)
+        end
+        @group.topic.configure({property => {requestId: mid, value: value}})
+      end
+
+      def method_missing(name, *args, &block)
+        if name =~ /set_(.+)/
+          configure($1, args[0], &block)
+        else
+          request(name, &block)
+        end
+      end
+
+      def delete_callback(requestId)
+        @callback_cache.delete(requestId)
+      end
+
+    end
+
+    # The reservation manager handles the creation and storage of node groups and stores all relevant information
+    # for the current experiment.
+    # If you need to talk to a single node, call the ResverationManager.groupForNode(nodeUrn) method.
+    # If you want a custom subset of nodes, call the ReservationManager.groupForNodes(nodeUrnArray) method.
+    # For talking to all nodes, you can get the approprita group bei calling ReservationManager.allNodesGroup.
+    class ReservationManager
+      @@reservation
+      @@nodeUrns
+      @@nodeGroups
+      @@reservationGroup
+
+      # Initializes the reservation manager class and creates all needed wise groups
+      #
+      # TODO explain parameters here
+      def self.init(reservation, nodeUrns)
+        @@nodeGroups = {}
+        @@reservation = reservation
+        @@nodeUrns = nodeUrns
+        @@reservationGroup = WiseOMF::Client::WiseGroup.new('ReservationGroup', self.reservationID)
+        @@reservationGroup.init_callback
+        # Creating the all nodes group:
+        self.allNodesGroup
+
+        # Creating the single node groups:
+        @@nodeUrns.each { |node|
+          self.groupForNode(node)
+        }
+
+      end
+
+      def self.reservationGroup
+        @@reservationGroup
+      end
+
+      def self.createGroupForNodes(nodeUrns, name = nil, &block)
+        groupId = WiseOMFUtils::UIDHelper.node_group_uid(@@reservation, nodeUrns)
+        if @@nodeGroups[groupId].nil?
+          if name.nil?
+            group = WiseOMF::Client::WiseGroup.new(nodeUrns.to_s, groupId)
+          else
+            group = WiseOMF::Client::WiseGroup.new(name, groupId)
+          end
+          @@nodeGroups[groupId] = group
+          group.init_callback
+          group.group.topic.on_message(:wait_for_membership) { |msg|
+            if msg.properties.membership && msg.properties.membership.include?(group.group.address)
+              info "New group setup finished"
+              group.group.topic.on_message(:wait_for_membership) {}
+              #group.init_callback
+              block.call(group) if block
+            end
+
+          }
+          @@reservationGroup.group.topic.create(:wisebed_node, {uid: groupId, urns: nodeUrns, membership: group.group.address})
+
+        end
+      end
+
+      # Returns a group to use when interacting with an arbitrary subset of the all nodes set
+      #
+      # @param[Array, Set, #read] a list of nodes to get the group for.
+      def self.groupForNodes(nodeUrns)
+        groupId = WiseOMFUtils::UIDHelper.node_group_uid(@@reservation, nodeUrns)
+        @@nodeGroups[groupId]
+      end
+
+      # Returns a group to work with when interacting with all nodes of the reservation
+      def self.allNodesGroup
+        groupId = WiseOMFUtils::UIDHelper.node_group_uid(@@reservation, @@nodeUrns)
+        if @@nodeGroups[groupId].nil?
+          @@nodeGroups[groupId] = WiseOMF::Client::WiseGroup.new('AllNodes', groupId)
+          @@nodeGroups[groupId].init_callback
+        end
+        @@nodeGroups[groupId]
+      end
+
+      # Returns a WiseGroup to talk to. This group should be used for interacting with single nodes.
+      #
+      # @param[String, #read] the node urn
+      def self.groupForNode(nodeUrn)
+        groupId = WiseOMFUtils::UIDHelper.node_group_uid(@@reservation, [nodeUrn])
+        if @@nodeGroups[groupId].nil?
+          @@nodeGroups[groupId] = WiseOMF::Client::WiseGroup.new(nodeUrn, groupId)
+          @@nodeGroups[groupId].init_callback
+        end
+        @@nodeGroups[groupId]
+      end
+
+      # Getter for the reservation id of the current reservation
+      def self.reservationID
+        WiseOMFUtils::UIDHelper.reservation_uid(@@reservation)
+      end
+
+
+    end
+  end
+end

data/lib/wise_omf/protobuf.rb

@@ -0,0 +1,3 @@
+require 'wise_omf/protobuf/external-plugin-messages.pb'
+require 'wise_omf/protobuf/iwsn-messages.pb'
+require 'wise_omf/protobuf/internal-messages.pb'

data/lib/wise_omf/server.rb

@@ -0,0 +1,4 @@
+require 'wise_omf/protobuf'
+require 'wise_omf/uid_helper'
+class Server
+end

data/lib/wise_omf.rb

@@ -0,0 +1,4 @@
+require 'wise_omf/client'
+require 'wise_omf/protobuf'
+class WiseOmf
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: wise_omf
+version: !ruby/object:Gem::Version
+  version: '0.9'
+platform: ruby
+authors:
+- Tobias Mende
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-19 00:00:00.000000000 Z
+dependencies: []
+description: This gem provides helpers for working with the testbed runtime via the
+  OMF (Orbit Measurement Framework)
+email: me@tobsolution.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/wise_omf.rb
+- lib/wise_omf/protobuf.rb
+- lib/wise_omf/server.rb
+- lib/wise_omf/client.rb
+homepage: https://github.com/wisebed/wiseomf
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: WiseOMF Utility Gem
+test_files: []