tcp_timeout 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d9724ad60f2d4c559625ebe47208f5b80049a95
+  data.tar.gz: 391eab9bc46bcf87a44fbacd2521b576ae95d4ae
+SHA512:
+  metadata.gz: 2b2bc9187ae35e53c37088bfb37086ebe007aec67b8d2483174eab9bc4815c532351fb08a79c37a5a05b25639c774c1b9508b5864800beb5faf2a61fa96caeea
+  data.tar.gz: 64dfb308baacce68080840119a9b5edd63ed0cfe2a40268c5b5ecb47aec789b00c09acf5f502224158108c8f0503cd5d36069085bedfc2aa950809ac03f0d53b

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Lann Martin
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# TCPTimeout
+
+A wrapper around Ruby Sockets providing timeouts for connect, write, and read
+operations using `Socket#*_nonblock` methods and `IO.select` instead of
+`Timeout.timeout`.
+
+## Usage
+
+`gem install tcp_timeout`
+
+Pass one or more of `:connect_timeout`, `:write_timeout`, and `:read_timeout`
+as options to TCPTimeout::TCPSocket.new. If a timeout is omitted or nil, that
+operation will behave as a normal Socket would. On timeout, a
+`TCPTimeout::SocketTimeout` (subclass of `SocketError`) will be raised.
+
+When calling `#read` with a byte length it is possible for it to read some data
+before timing out. If you need to avoid losing this data you can pass a buffer
+string which will receive the data even after a timeout.
+
+Other options:
+
+- `:family` - set the address family for the connection, e.g. `:INET` or `:INET6`
+- `:local_host` and `:local_port` - the host and port to bind to
+
+TCPTimeout::TCPSocket supports only a subset of IO methods, including:
+
+```close closed? read read_nonblock readbyte readpartial write write_nonblock```
+
+**Example:**
+
+```ruby
+begin
+  sock = TCPTimeout::TCPSocket.new(host, port, connect_timeout: 10, write_timeout: 9)
+  sock.write('data')
+  sock.close
+rescue TCPTimeout::SocketTimeout
+  puts "Operation timed out!"
+end
+```

data/lib/tcp_timeout.rb

@@ -0,0 +1,163 @@
+require 'socket'
+
+module TCPTimeout
+  VERSION = "0.1.1"
+
+  DELEGATED_METHODS = %w[
+    close closed?
+    getsockopt setsockopt
+    local_address remote_address
+    read_nonblock wrote_nonblock
+    fileno
+  ]
+
+  class SocketTimeout < SocketError; end
+
+  class TCPSocket
+    DELEGATED_METHODS.each do |method|
+      class_eval(<<-EVAL, __FILE__, __LINE__)
+        def #{method}(*args)
+          @socket.__send__(:#{method}, *args)
+        end
+      EVAL
+    end
+
+    def initialize(host, port, opts = {})
+      @connect_timeout = opts[:connect_timeout]
+      @write_timeout = opts[:write_timeout]
+      @read_timeout = opts[:read_timeout]
+
+      family = opts[:family] || Socket::AF_INET
+      address = Socket.getaddrinfo(host, nil, family).first[3]
+      @sockaddr = Socket.pack_sockaddr_in(port, address)
+
+      @socket = Socket.new(family, Socket::SOCK_STREAM, 0)
+      @socket.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
+
+      local_host = opts[:local_host]
+      local_port = opts[:local_port]
+      if local_host || local_port
+        local_host ||= ''
+        local_address = Socket.getaddrinfo(local_host, nil, family).first[3]
+        local_sockaddr = Socket.pack_sockaddr_in(local_port, local_address)
+        @socket.bind(local_sockaddr)
+      end
+
+      connect
+    end
+
+    def connect
+      return @socket.connect(@sockaddr) unless @connect_timeout
+
+      begin
+        @socket.connect_nonblock(@sockaddr)
+      rescue Errno::EINPROGRESS
+        select_timeout(:connect, @connect_timeout)
+        # If there was a failure this will raise an Error
+        begin
+          @socket.connect_nonblock(@sockaddr)
+        rescue Errno::EISCONN
+          # Successfully connected
+        end
+      end
+    end
+
+    def write(data, timeout = nil)
+      timeout ||= @write_timeout
+      return @socket.write(data) unless timeout
+
+      length = data.bytesize
+
+      total_count = 0
+      loop do
+        begin
+          count = @socket.write_nonblock(data)
+        rescue Errno::EWOULDBLOCK
+          timeout = select_timeout(:write, timeout)
+          retry
+        end
+
+        total_count += count
+        return total_count if total_count >= length
+        data = data.byteslice(count..-1)
+      end
+    end
+
+    def read(length = nil, *args)
+      raise ArgumentError, 'too many arguments' if args.length > 2
+
+      timeout = (args.length > 1) ? args.pop : @read_timeout
+      return @socket.read(length, *args) unless length > 0 && timeout
+
+      buffer = args.first || ''.force_encoding(Encoding::ASCII_8BIT)
+
+      begin
+        # Drain internal buffers
+        @socket.read_nonblock(length, buffer)
+        return buffer if buffer.bytesize >= length
+      rescue Errno::EWOULDBLOCK
+        # Internal buffers were empty
+        buffer.clear
+      rescue EOFError
+        return nil
+      end
+
+      @chunk ||= ''.force_encoding(Encoding::ASCII_8BIT)
+
+      loop do
+        timeout = select_timeout(:read, timeout)
+
+        begin
+          @socket.read_nonblock(length, @chunk)
+        rescue Errno::EWOULDBLOCK
+          retry
+        rescue EOFError
+          return buffer.empty? ? nil : buffer
+        end
+        buffer << @chunk
+
+        if length
+          length -= @chunk.bytesize
+          return buffer if length <= 0
+        end
+      end
+    end
+
+    def readpartial(length, *args)
+      raise ArgumentError, 'too many arguments' if args.length > 2
+
+      timeout = (args.length > 1) ? args.pop : @read_timeout
+      return @socket.readpartial(length, *args) unless length > 0 && timeout
+
+      begin
+        @socket.read_nonblock(length, *args)
+      rescue Errno::EWOULDBLOCK
+        timeout = select_timeout(:read, timeout)
+        retry
+      end
+    end
+
+    def readbyte
+      readpartial(1).ord
+    end
+
+    private
+
+    def select_timeout(type, timeout)
+      if timeout >= 0
+        if type == :read
+          read_array = [@socket]
+        else
+          write_array = [@socket]
+        end
+
+        start = Time.now
+        if IO.select(read_array, write_array, [@socket], timeout)
+          waited = Time.now - start
+          return timeout - waited
+        end
+      end
+      raise SocketTimeout, "#{type} timeout"
+    end
+  end
+end

data/tcp_timeout.gemspec

@@ -0,0 +1,18 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tcp_timeout'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tcp_timeout"
+  spec.version       = TCPTimeout::VERSION
+  spec.authors       = ["Lann Martin"]
+  spec.email         = ["tcptimeoutgem@lannbox.com"]
+  spec.summary       = "TCPSocket proxy with select-based timeouts"
+  spec.description   = "Wraps Socket, providing timeouts for connect, write, and read without Timeout.timeout."
+  spec.homepage      = "https://github.com/lann/tcp-timeout-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: tcp_timeout
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Lann Martin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-15 00:00:00.000000000 Z
+dependencies: []
+description: Wraps Socket, providing timeouts for connect, write, and read without
+  Timeout.timeout.
+email:
+- tcptimeoutgem@lannbox.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/tcp_timeout.rb
+- tcp_timeout.gemspec
+homepage: https://github.com/lann/tcp-timeout-ruby
+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.0
+signing_key: 
+specification_version: 4
+summary: TCPSocket proxy with select-based timeouts
+test_files: []