net-proto 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83b848fce79a24c404a269ecfaf838c8999e000a
-  data.tar.gz: 33fada4059a1ac04b305e0d04b621d777cc4e5e9
+  metadata.gz: 9ad82469ee27db26ef64fc237b2f0997c128e491
+  data.tar.gz: b75d18a5640061415124e0db9a4c9d984a09e1af
 SHA512:
-  metadata.gz: fd37187da1d51e62cf87fb54dab95ab6a5dc718aa397f25b9fb7e2e7898926d00ef38445bfa71619606ddee887610bbb89fb103b7f39fcc989fddb3ef8e5b270
-  data.tar.gz: d36e65afe0656f492d34ada92d6833aa18da0c36ec3846b26bb1cef8172c64a82dadda712d6c282d86c811013e597bb7745e9cb5a1ecc500ec23f06dab869968
+  metadata.gz: bc8b339c75aa05037c264351888309c7d65392f3db57cdaf89cab05ca46584a8747501e905b999e0fb0f2aa30b7a6f1fb12bbea84d0baaddf8c2995e694c58bd
+  data.tar.gz: b056f5cb415e6cbf756c5e9e4e36f77f29bf66844e493f243ace79ee5f1ce662a35a9924963f62c30c1f386ae29aa58f78a99275fa5204a3739e1a25d2906a1e

data/CHANGES

@@ -1,3 +1,8 @@
+== 1.2.0 - 3-Nov-2014
+* The getprotobynumber and getprotobyname methods on MS Windows now accept
+  optional window and message arguments. If used, the method becomes
+  asynchronous and yields a block instead.
+
 == 1.1.1 - 9-Oct-2014
 * Implemented getprotoent on Windows using pure Ruby.
 * Miscellaneous minor updates to the Rakefile, gemspec and docs.

data/doc/netproto.txt

@@ -58,10 +58,6 @@ Proto.getprotoent{ |struct| ... }
   None that I'm aware of. Please log any bug reports on the project page
   at https://github.com/djberg96/net-proto.
 	
-== Future Plans
-  Use the asynchronous calls (WSAAsyncGetProtoByName and
-  WSAAsyncGetProtoByNumber) on MS Windows systems.
-	
 == Copyright
   (C) 2003-2014 Daniel J. Berger
   All rights reserved.

data/lib/net/proto/common.rb

@@ -5,7 +5,7 @@ module Net
     extend FFI::Library
 
     # The version of the net-proto library
-    VERSION = '1.1.1'
+    VERSION = '1.2.0'
 
     private_class_method :new
 

data/lib/windows/net/proto.rb

@@ -15,9 +15,15 @@ module Net
     # These should exist on every platform.
     attach_function :getprotobyname_c, :getprotobyname, [:string], :pointer
     attach_function :getprotobynumber_c, :getprotobynumber, [:int], :pointer
+    attach_function :WSAAsyncGetProtoByName, [:uintptr_t, :uint, :string, :pointer, :pointer], :uintptr_t
+    attach_function :WSAAsyncGetProtoByNumber, [:uintptr_t, :uint, :int, :pointer, :pointer], :uintptr_t
+    attach_function :WSAGetLastError, [], :int
 
     private_class_method :getprotobyname_c
     private_class_method :getprotobynumber_c
+    private_class_method :WSAAsyncGetProtoByName
+    private_class_method :WSAAsyncGetProtoByNumber
+    private_class_method :WSAGetLastError
 
     public
 
@@ -47,17 +53,38 @@ module Net
     #    Net::Proto.getprotobyname('tcp')   # => 6
     #    Net::Proto.getprotobyname('bogus') # => nil
     #
-    def self.getprotobyname(protocol)
+    # On MS Windows, you may also pass a window handle and a message (int)
+    # that window will receive. If present, this method becomes asynchronous
+    # and yields a block instead, with the protocol and handle.
+    #
+    # Example:
+    #
+    #   Net::Proto.getprotobyname('tcp', SOME_WINDOW, SOME_MSG){ |num, handle| ... }
+    #
+    def self.getprotobyname(protocol, hwnd = 0, msg = 0)
       raise TypeError unless protocol.is_a?(String)
 
-      begin
-        ptr = getprotobyname_c(protocol)
-        struct = ProtocolStruct.new(ptr) unless ptr.null?
-      ensure
-        endprotoent() if respond_to?(:endprotoent, true)
-      end
+      if hwnd && hwnd > 0
+        struct = ProtocolStruct.new
+        size_ptr = FFI::MemoryPointer.new(:int)
+        size_ptr.write_int(struct.size)
+
+        handle = WSAAsyncGetProtoByName(hwnd, msg, protocol, struct, size_ptr)
 
-      ptr.null? ? nil : struct[:p_proto]
+        if handle == 0
+          raise SystemCallError.new('WSAAsyncGetProtoByName', WSAGetLastError())
+        end
+
+        yield struct[:p_proto], handle
+      else
+        begin
+          ptr = getprotobyname_c(protocol)
+          struct = ProtocolStruct.new(ptr) unless ptr.null?
+        ensure
+          endprotoent() if respond_to?(:endprotoent, true)
+        end
+        ptr.null? ? nil : struct[:p_proto]
+      end
     end
 
     # Given a protocol number, returns the corresponding string, or nil if
@@ -68,17 +95,39 @@ module Net
     #   Net::Proto.getprotobynumber(6)   # => 'tcp'
     #   Net::Proto.getprotobynumber(999) # => nil
     #
-    def self.getprotobynumber(protocol)
+    # On MS Windows, you may also pass a window handle and a message (int)
+    # that window will receive. If present, this method becomes asynchronous
+    # and yields a block instead, with the protocol and handle.
+    #
+    # Example:
+    #
+    #   Net::Proto.getprotobynumber(6, SOME_WINDOW, SOME_MSG){ |name, handle| ... }
+    #
+    def self.getprotobynumber(protocol, hwnd = 0, msg = 0)
       raise TypeError unless protocol.is_a?(Integer)
 
-      begin
-        ptr = getprotobynumber_c(protocol)
-        struct = ProtocolStruct.new(ptr) unless ptr.null?
-      ensure
-        endprotoent() if respond_to?(:endprotoent, true)
-      end
+      if hwnd && hwnd > 0
+        struct = ProtocolStruct.new
+        size_ptr = FFI::MemoryPointer.new(:int)
+        size_ptr.write_int(struct.size)
+
+        handle = WSAAsyncGetProtoByNumber(hwnd, msg, protocol, struct, size_ptr)
 
-      ptr.null? ? nil: struct[:p_name]
+        if handle == 0
+          raise SystemCallError.new('WSAAsyncGetProtoByNumber', WSAGetLastError())
+        end
+
+        yield struct[:p_name], handle
+      else
+        begin
+          ptr = getprotobynumber_c(protocol)
+          struct = ProtocolStruct.new(ptr) unless ptr.null?
+        ensure
+          endprotoent() if respond_to?(:endprotoent, true)
+        end
+
+        ptr.null? ? nil: struct[:p_name]
+      end
     end
 
     # In block form, yields each entry from /etc/protocol as a struct of type

data/net-proto.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 Gem::Specification.new do |gem|
   gem.name       = 'net-proto'
-  gem.version    = '1.1.1'
+  gem.version    = '1.2.0'
   gem.author     = 'Daniel J. Berger'
   gem.license    = 'Artistic 2.0'
   gem.email      = 'djberg96@gmail.com'

data/test/test_net_proto.rb

@@ -24,7 +24,7 @@ class TC_Net_Proto < Test::Unit::TestCase
   end
 
   test "version number is set to expected value" do
-    assert_equal('1.1.1', Net::Proto::VERSION)
+    assert_equal('1.2.0', Net::Proto::VERSION)
   end
 
   test "get_protocol method basic functionality" do

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: net-proto
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Daniel J. Berger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-09 00:00:00.000000000 Z
+date: 2014-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.2.0
 - !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: |2
@@ -89,17 +89,17 @@ 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.4.1
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: A Ruby interface for determining protocol information