katcp 0.1.4 → 0.1.6

data/lib/katcp/client/roach.rb

@@ -139,12 +139,15 @@ module KATCP
     #
     # Supported keys for the +opts+ Hash are:
     #
-    #   :remote_host  Specifies hostname of KATCP server
-    #   :remote_port  Specifies port used by KATCP server (default 7147)
-    #   :local_host   Specifies local interface to bind to (default nil)
-    #   :local_port   Specifies local port to bind to (default nil)
-    #   :typemap      Provides a default device typemap (default {}).
-    #                 See #device_typemap for details.
+    #   :remote_host    Specifies hostname of KATCP server
+    #   :remote_port    Specifies port used by KATCP server
+    #                   (default ENV['KATCP_PORT'] || 7147)
+    #   :local_host     Specifies local interface to bind to (default nil)
+    #   :local_port     Specifies local port to bind to (default nil)
+    #   :socket_timeout Specifies timeout for socket operations
+    #                   (default DEFAULT_SOCKET_TIMEOUT)
+    #   :typemap        Provides a default device typemap (default {}).
+    #                   See #device_typemap for details.
     def initialize(*args)
       # List of all devices
       @devices = [];

data/lib/katcp/client.rb

@@ -2,6 +2,7 @@ require 'rubygems'
 require 'thread'
 require 'monitor'
 require 'socket'
+require 'timeout'
 
 require 'katcp/response'
 require 'katcp/util'
@@ -25,10 +26,13 @@ module KATCP
     #
     # Supported keys for the +opts+ Hash are:
     #
-    #   :remote_host  Specifies hostname of KATCP server
-    #   :remote_port  Specifies port used by KATCP server (default 7147)
-    #   :local_host   Specifies local interface to bind to (default nil)
-    #   :local_port   Specifies local port to bind to (default nil)
+    #   :remote_host    Specifies hostname of KATCP server
+    #   :remote_port    Specifies port used by KATCP server
+    #                   (default ENV['KATCP_PORT'] || 7147)
+    #   :local_host     Specifies local interface to bind to (default nil)
+    #   :local_port     Specifies local port to bind to (default nil)
+    #   :socket_timeout Specifies timeout for socket operations
+    #                   (default DEFAULT_SOCKET_TIMEOUT)
     def initialize(*args)
       # If final arg is a Hash, pop it off
       @opts = (Hash === args[-1]) ? args.pop : {}
@@ -36,10 +40,17 @@ module KATCP
       # Save parameters
       remote_host, remote_port, local_host, local_port = args
       @remote_host = remote_host ? remote_host.to_s : @opts[:remote_host].to_s
-      @remote_port = remote_port || @opts[:remote_port] || 7147
+      @remote_port = remote_port || @opts[:remote_port] || ENV['KATCP_PORT'] || 7147
       @local_host = local_host || @opts[:local_host]
       @local_port = local_port || @opts[:local_port]
 
+      # Make sure @remote_port is Integer, if not use default of 7147
+      @remote_port = Integer(@remote_port) rescue 7147
+
+      # Create sockaddr from remote host and port.  This can raise
+      # "SocketError: getaddrinfo: Name or service not known".
+      @sockaddr = Socket.sockaddr_in(@remote_port, @remote_host)
+
       # Init attribute(s)
       @informs = []
 
@@ -57,7 +68,7 @@ module KATCP
       @rxq = Queue.new
 
       # Timeout value for socket operations
-      @socket_timeout = DEFAULT_SOCKET_TIMEOUT
+      @socket_timeout = @opts[:socket_timeout] || DEFAULT_SOCKET_TIMEOUT
 
       # No socket yet
       @socket = nil
@@ -76,33 +87,22 @@ module KATCP
 
       # Create new socket.
       @socket = Socket.new(Socket::AF_INET, Socket::SOCK_STREAM, 0)
-      sockaddr = Socket.sockaddr_in(@remote_port, @remote_host)
 
-      # Do non-blocking connect
+      # Do connect in timeout block
       begin
-        @socket.connect_nonblock(sockaddr)
-      rescue Errno::EINPROGRESS
-        # Wait with timeout for @socket to become writable.
-        # Is DEFAULT_SOCKET_TIMEOUT seconds an OK timeout for connect?
-        rd_wr_err = select([], [@socket], [], DEFAULT_SOCKET_TIMEOUT)
-        if rd_wr_err.nil?
-          # Timeout during connect, close socket and raise TimeoutError
-          @socket.close
-          raise TimeoutError.new(
-            'connection timed out in %.3f seconds' % DEFAULT_SOCKET_TIMEOUT)
+        Timeout::timeout(@socket_timeout) do
+          @socket.connect(@sockaddr)
         end
-
-        # Verify that we're connected
-        begin
-          @socket.connect_nonblock(sockaddr)
-        rescue Errno::EISCONN # expected
-          # ignore
-        rescue # anything else, unexpected
-          # Close socket and re-raise
-          @socket.close
-          raise
+      rescue => e
+        # Close socket
+        @socket.close
+        # Change e to TimeoutError instead of Timeout::Error
+        if Timeout::Error === e
+          e = TimeoutError.new(
+            'connection timed out in %.3f seconds' % @socket_timeout)
         end
-      end # non-blocking connect
+        raise e
+      end
 
       # Start thread that reads data from server.
       Thread.new do

data/lib/katcp/version.rb

@@ -3,5 +3,5 @@
 #++
 
 module KATCP
-  VERSION = "0.1.4"
+  VERSION = "0.1.6"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: katcp
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 6
+  version: 0.1.6
 platform: ruby
 authors: 
 - David MacMahon
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-03-04 00:00:00 Z
+date: 2013-04-25 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: narray
@@ -59,7 +59,7 @@ rdoc_options:
 - -m
 - README
 - --title
-- Ruby/KATCP 0.1.4 Documentation
+- Ruby/KATCP 0.1.6 Documentation
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement