discovery 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 204a4d851db30ec0c717303d933b3a2f02aa8ef4
+  data.tar.gz: fee2b6b4a7b55e80cf87f8a535c3ff1d42487c73
+SHA512:
+  metadata.gz: 98eee54e5dd469906d625ab2a25f5040a1b58d2cbb36dcde8f048fb93e323660767e196314ecbd7c0a667c6bef79facab4000d51a813810a59cb4287444e9c0b
+  data.tar.gz: d8f6778c0b2a8b56a48ca568043acc770ef664c9a4522a6d6927868c924bd89c497e252e962e681d8654ad86f2e3887103500eb0691fbe2e8dbf9c019631054f

data/lib/discovery/udp.rb

@@ -0,0 +1,54 @@
+
+require_relative 'util/udp'
+require 'timeout'
+
+module Discovery
+  class UDP
+    @port  =  0
+    @group = "0.0.0.0"
+    
+    def self.new; raise NotImplementedError nil end
+    
+    # Register a callback to be used in the event of a recognized beacon.
+    # Each non-nil response object for each UDP beacon will be yielded to it.
+    def self.listen &block
+      @blocks ||= []
+      (@blocks << block).uniq!
+      
+      @thread ||= Thread.new do
+        loop do
+          @discoverables.values.each_with_object(next_beacon) do |blk,beacon|
+            obj = blk.call beacon
+            @blocks.each do |callback|
+              callback.call(obj)
+            end unless obj.nil?
+          end
+        end
+      end
+    end
+    
+    # Return the info hash of the next DDDP beacon detected - blocking
+    # Optional :timeout keyword argument specifies maximum time to block
+    def self.next_beacon timeout:nil
+      @udp_rx ||= Util::UDP::RX.new(@group, @port)
+      beacon_to_hash(Timeout.timeout(timeout) { @udp_rx.gets })
+    end
+    
+    # Convert the incoming beacon to a Hash containing all necessary info
+    # Implement to something nontrivial in the inherited module
+    def self.beacon_to_hash beacon
+      {beacon:beacon}
+    end
+    
+    # Register a block to be used to convert a recognized
+    # beacon info-hash into a response object.
+    # The block should accept the info hash as an argument and
+    # return the response object or nil if the beacon isn't recognized.
+    class << self; attr_reader :discoverables; end
+    def self.register cls, &block
+      @discoverables ||= {}
+      @discoverables[cls] = block
+    end
+    
+  end
+end

data/lib/discovery/util/udp.rb

@@ -0,0 +1,115 @@
+
+require 'socket'
+require 'ipaddr'
+
+module Discovery
+  module Util
+    module UDP
+      
+      class << self;  attr_accessor :max_length;  end
+      @max_length = 1024 # default max payload length
+      
+      class Xceiver
+        attr_reader :group, :port, :socket, :local_ip, :local_port
+        
+        def self.new(*args)
+          if (self.class==Xceiver)
+            raise TypeError, "#{self.class} is an 'abstract class' only."\
+                             "  Inherit it; don't instantiate it!"; end
+          super
+        end
+        
+        def initialize(group, port, **kwargs)
+          @group = group
+          @port  = port
+          kwargs.each_pair { |k,v| instance_variable_set("@#{k}".to_sym, v) }
+          open
+        end
+        
+        def open
+          @socket.close if @socket
+          @socket = UDPSocket.new
+          configure
+          @local_ip = Socket.ip_address_list.detect{|intf| intf.ipv4_private?}
+          @local_port = @socket.addr[1]
+          return @socket
+        ensure
+          @finalizer ||= ObjectSpace.define_finalizer self, Proc.new { close }
+        end
+        
+        def close
+          @socket.close if @socket
+          @socket = nil
+        end
+      end
+      
+      
+      class TX < Xceiver
+        def configure
+          # Set up for multicasting
+          @socket.setsockopt Socket::IPPROTO_IP,
+                             Socket::IP_MULTICAST_TTL,
+                             [1].pack('i')
+          # Bind to any available port
+          @socket.bind "0.0.0.0", (@bind_port or 0)
+        end
+        
+        def puts(m)
+          max = UDP.max_length
+          if m.size > max
+            self.puts m[0...max]
+            self.puts m[max...m.size]
+          else
+            @socket.send(m, 0, @group, @port)
+            m
+          end
+        end
+      end
+      
+      
+      class RX < Xceiver
+        def configure
+          # Add membership to the multicast group
+          @socket.setsockopt Socket::IPPROTO_IP,
+                             Socket::IP_ADD_MEMBERSHIP,
+                             IPAddr.new(@group).hton + IPAddr.new("0.0.0.0").hton
+          # Don't prevent future listening peers on the same machine
+          @socket.setsockopt(Socket::SOL_SOCKET,
+                             Socket::SO_REUSEADDR,
+                             [1].pack('i')) unless @selfish
+          # Bind the socket to the specified port or any open port on the machine
+          @socket.bind Socket::INADDR_ANY, @port
+        end
+        
+        def gets
+          msg, addrinfo = @socket.recvfrom(UDP.max_length)
+          msg.instance_variable_set :@source, addrinfo[3].to_s+':'+addrinfo[1].to_s
+          class << msg;  attr_reader :source;  end
+          msg
+        end
+        
+        def test!(message="#{self}.test!")
+          tx = UDP::TX.new @group, @port
+          rx = self
+          
+          outer_thread = Thread.current
+          passed = false
+          thr = Thread.new do
+            rx.gets
+            passed = true
+            outer_thread.wakeup
+          end
+          Thread.pass
+          
+          tx.puts message
+          sleep 1 if thr.status
+          thr.kill
+          tx.close
+          
+          passed
+        end
+      end
+      
+    end
+  end
+end

data/lib/discovery.rb

@@ -0,0 +1,2 @@
+
+require_relative 'discovery/udp'

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: discovery
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Joe McIlvain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Device and service discovery.
+email: joe.eli.mac@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/discovery.rb
+- lib/discovery/util/udp.rb
+- lib/discovery/udp.rb
+homepage: https://github.com/jemc/discovery/
+licenses:
+- Copyright 2013 Joe McIlvain. MIT Licensed.
+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.1.5
+signing_key: 
+specification_version: 4
+summary: discovery
+test_files: []