phidgets-ffi 0.0.4 → 0.0.5

data/examples/dictionary.rb

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'phidgets-ffi'
+
+Phidgets::Log.enable(:verbose)
+
+puts "Library Version: #{Phidgets::FFI.library_version}"
+Phidgets::Dictionary.new do |dict|
+  dict.on_error do |obj, code, reason|
+    puts "Error (#{code}): #{reason}"
+  end
+  dict.on_connect do |obj|
+    print "Connected!\n"
+  end
+  dict.on_disconnect do |obj|
+    print "Disconnected!\n"
+  end
+  
+  dict.on_change('fnord') do |obj, key, val, reason|
+      print "Fnord key: #{key} => #{val}, #{reason}\n"
+  end
+  dict.on_change do |obj, key, val, reason|
+      print "Every key: #{key} => #{val}, #{reason}\n"
+  end
+  dict.on_change('test') do |obj, key, val, reason|
+      print "Keys matching test: #{key} => #{val}, #{reason}\n"
+  end
+
+  puts "Listening to: #{dict.listeners.inspect}"
+
+  dict.remove_on_change('fnord')
+
+  puts "Listening to: #{dict.listeners.inspect}"
+
+  dict["fnord"] = "This is a fnordic key"
+  dict["test"] = "This is a key that is called test"
+  dict["fnord"] = nil
+  dict["snoop"] = nil
+  20.times do |i|
+    print "#{i}\n"
+    begin
+      dict["testerson"] = "This is another test matching key"
+    rescue Phidgets::Error::NetworkNotConnected
+    end
+    sleep 1
+  end
+end

data/lib/phidgets-ffi.rb

@@ -11,6 +11,7 @@ require 'phidgets-ffi/ffi/interface_kit'
 
 require 'phidgets-ffi/common'
 require 'phidgets-ffi/log'
+require 'phidgets-ffi/dictionary'
 require 'phidgets-ffi/error'
 require 'phidgets-ffi/manager'
 require 'phidgets-ffi/servo'

data/lib/phidgets-ffi/dictionary.rb

@@ -0,0 +1,161 @@
+module Phidgets
+  class Dictionary
+
+    Klass = Phidgets::FFI::CPhidgetDictionary
+    include Utility
+    
+    def initialize(options={}, &block)
+      @listeners = {}
+      @options = {:address => 'localhost', :port => 5001, :server_id => nil, :password => nil}.merge(options)
+
+      create
+      if block_given?
+        open(@options)
+        yield self
+        close
+        delete_dict
+      end
+    end
+
+    def create
+      ptr = ::FFI::MemoryPointer.new(:pointer, 1)
+      Klass.create(ptr)        
+      @handle = ptr.get_pointer(0)
+      true
+    end
+
+    def open(options)
+      password = (options[:password].nil? ? nil : options[:password].to_s)
+      if !options[:server_id].nil?
+        Klass.openRemote(@handle, options[:server_id].to_s, password)
+      else
+        Klass.openRemoteIP(@handle, options[:address].to_s, options[:port].to_i, password)
+      end
+      sleep 1
+      true
+    end
+    
+    def close
+      Klass.close(@handle)
+      true
+    end
+
+    def delete_dict
+      Klass.delete(@handle)
+      true
+    end
+    
+    def []=(key, val, persistent=false)      
+      # If we are assigning something to nil, let's remove it
+      if val.nil?
+        delete(key)
+      else
+        persistent = (persistent ? 1 : 0)
+        Klass.addKey(@handle, key.to_s, val.to_s, persistent)
+        val.to_s
+      end
+    end
+    alias_method :add, :[]=
+    alias_method :put, :[]=
+    
+    def [](key)
+      ptr = ::FFI::MemoryPointer.new(:string, 8192)
+      Klass.getKey(@handle, key, ptr, 8192)
+      ptr.get_string(0)
+    end
+    alias_method :get, :[]
+
+    def delete(pattern)      
+      Klass.removeKey(@handle, (pattern.kind_of?(Regexp) ? pattern.source : pattern.to_s))
+      true
+    end
+    
+    def on_connect(obj=nil, &block)
+      @on_connect_obj = obj
+      @on_connect = Proc.new { |handle, obj_ptr|
+        # On connect, we'll need to re-add all of our change handlers
+        @listeners.each_pair do |pattern, (listener, proc)|
+          begin
+            next if status != :connected
+            Klass.set_OnKeyChange_Handler(@handle, listener, pattern, proc, pointer_for(obj))              
+            sleep 0.5
+          rescue
+            Phidgets::Log.error("#{self.class}::on_connect", $!.to_s)
+          end
+        end
+        yield object_for(obj_ptr)
+      }
+      Klass.set_OnServerConnect_Handler(@handle, @on_connect, pointer_for(obj))
+    end
+    
+    def on_disconnect(obj=nil, &block)
+      @on_disconnect_obj = obj
+      @on_disconnect = Proc.new { |handle, obj_ptr|
+        # On disconnect, we'll need to remove all of our change handlers
+        @listeners.each_pair do |pattern, (listener, proc)|
+          Klass.remove_OnKeyChange_Handler(listener.get_pointer(0))
+        end
+        yield object_for(obj_ptr)
+      }
+      Klass.set_OnServerDisconnect_Handler(@handle, @on_disconnect, pointer_for(obj))
+    end
+    
+    def on_error(obj=nil, &block)
+      @on_error_obj = obj
+      @on_error = Proc.new { |handle, obj_ptr, code, error|
+        yield object_for(obj_ptr), code, error
+      }
+      Klass.set_OnError_Handler(@handle, @on_error, pointer_for(obj))
+    end
+
+
+    def on_change(pattern=".*", obj=nil, &block)
+      pattern = (pattern.kind_of?(Regexp) ? pattern.source : pattern.to_s)
+      @listeners[pattern] = [
+        ::FFI::MemoryPointer.new(:pointer),
+        Proc.new { |handle, obj_ptr, key, value, reason|
+          yield object_for(obj_ptr), key, value, reason
+        }
+      ]
+      Klass.set_OnKeyChange_Handler(@handle, @listeners[pattern][0], pattern, @listeners[pattern][1], pointer_for(obj))
+      sleep 0.5
+    end
+
+    def remove_on_change(pattern)
+      pattern = (pattern.kind_of?(Regexp) ? pattern.source : pattern.to_s)
+      if @listeners.has_key?(pattern)
+        listener, proc = @listeners.delete(pattern)
+        Klass.remove_OnKeyChange_Handler(listener.get_pointer(0))
+        sleep 0.5
+        true
+      else
+        nil
+      end
+    end
+    
+    def listeners
+      @listeners.keys
+    end
+
+    def server_id
+      ptr = ::FFI::MemoryPointer.new(:string)
+      Klass.getServerID(@handle, ptr)
+      ptr.get_string(0)
+    end
+
+    def status
+      ptr = ::FFI::MemoryPointer.new(:int)
+      Klass.getServerStatus(@handle, ptr)
+      Phidgets::FFI::ServerStatus[ptr.get_int(0)]
+    end
+
+    def server_address
+      str_ptr, int_ptr = ::FFI::MemoryPointer.new(:string), ::FFI::MemoryPointer.new(:int)
+      Klass.getServerID(@handle, str_ptr, int_ptr)
+      strPtr = str_ptr.get_pointer(0)
+      address = (strPtr.null? ? nil : strPtr.read_string)
+      port = int_ptr.get_int(0)
+      [address, port]
+    end
+  end
+end

data/lib/phidgets-ffi/ffi/constants.rb

@@ -3,6 +3,11 @@ module Phidgets
     typedef :pointer, :phid
     typedef :pointer, :user_ptr
         
+    ServerStatus = enum(
+      :disconnected, 0,
+      :connected
+    )
+
     DeviceStatus = enum(
       :detached, 0,
       :attached

data/lib/phidgets-ffi/ffi/dictionary.rb

@@ -8,7 +8,10 @@ module Phidgets
       :removed,
       :unchanged
     )
+
     attach_function :CPhidgetDictionary_create, [:dict], :int #int CPhidgetDictionary_create(CPhidgetDictionaryHandle *dict);
+    attach_function :CPhidgetDictionary_openRemote, [:dict, :string, :string], :int #int CPhidgetDictionary_openRemote(CPhidgetDictionaryHandle dict, const char *serverID, const char *password);
+    attach_function :CPhidgetDictionary_openRemoteIP, [:dict, :string, :int, :string], :int #int CPhidgetDictionary_openRemoteIP(CPhidgetDictionaryHandle dict, const char *address, int port, const char *password);
     attach_function :CPhidgetDictionary_close, [:dict], :int #int CPhidgetDictionary_close(CPhidgetDictionaryHandle dict);
     attach_function :CPhidgetDictionary_delete, [:dict], :int #int CPhidgetDictionary_delete(CPhidgetDictionaryHandle dict);
     callback :CPhidgetDictionary_set_OnError_Callback, [:dict, :pointer, :int, :string], :int
@@ -23,8 +26,6 @@ module Phidgets
     attach_function :CPhidgetDictionary_getServerID, [:dict, :pointer], :int #int CPhidgetDictionary_getServerID(CPhidgetDictionaryHandle dict, const char **serverID);
     attach_function :CPhidgetDictionary_getServerAddress, [:dict, :pointer, :pointer], :int #int CPhidgetDictionary_getServerAddress(CPhidgetDictionaryHandle dict, const char **address, int *port);
     attach_function :CPhidgetDictionary_getServerStatus, [:dict, :pointer], :int #int CPhidgetDictionary_getServerStatus(CPhidgetDictionaryHandle dict, int *serverStatus);
-    attach_function :CPhidgetDictionary_openRemote, [:dict, :string, :string], :int #int CPhidgetDictionary_openRemote(CPhidgetDictionaryHandle dict, const char *serverID, const char *password);
-    attach_function :CPhidgetDictionary_openRemoteIP, [:dict, :string, :int, :string], :int #int CPhidgetDictionary_openRemoteIP(CPhidgetDictionaryHandle dict, const char *address, int port, const char *password);
     callback :CPhidgetDictionary_set_OnKeyChange_Callback, [:dict, :pointer, :string, :string, KeyChangeReason], :int
     attach_function :CPhidgetDictionary_set_OnKeyChange_Handler, [:dict, :pointer, :string, :CPhidgetDictionary_set_OnKeyChange_Callback, :pointer], :int #int CPhidgetDictionary_set_OnKeyChange_Handler(CPhidgetDictionaryHandle dict, CPhidgetDictionaryListenerHandle *dictlistener, const char *pattern, CPhidgetDictionary_OnKeyChange_Function fptr, void *userPtr);
     attach_function :CPhidgetDictionary_remove_OnKeyChange_Handler, [:dict], :int #int CPhidgetDictionary_remove_OnKeyChange_Handler(CPhidgetDictionaryListenerHandle dictlistener);

data/lib/phidgets-ffi/version.rb

@@ -1,5 +1,5 @@
 module Phidgets
   module FFI
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: phidgets-ffi
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Kelley Reynolds
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-13 00:00:00 -04:00
+date: 2011-07-17 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -65,6 +65,7 @@ files:
 - LICENSE
 - README.rdoc
 - Rakefile
+- examples/dictionary.rb
 - examples/ffi/dictionary.rb
 - examples/ffi/interface_kit.rb
 - examples/ffi/library_version.rb
@@ -77,6 +78,7 @@ files:
 - examples/servo.rb
 - lib/phidgets-ffi.rb
 - lib/phidgets-ffi/common.rb
+- lib/phidgets-ffi/dictionary.rb
 - lib/phidgets-ffi/error.rb
 - lib/phidgets-ffi/ffi/common.rb
 - lib/phidgets-ffi/ffi/constants.rb