module Bunny::Socket

TCP socket extension that uses TCP_NODELAY and supports reading fully.

Heavily inspired by Dalli by Mike Perham. @private

Constants

READ_RETRY_EXCEPTION_CLASSES
WRITE_RETRY_EXCEPTION_CLASSES

Attributes

options[RW]

Public Class Methods

open(host, port, options = {}) click to toggle source
# File lib/bunny/cruby/socket.rb, line 28
def self.open(host, port, options = {})
  socket = ::Socket.tcp(host, port, nil, nil,
                        connect_timeout: options[:connect_timeout])
  if ::Socket.constants.include?('TCP_NODELAY') || ::Socket.constants.include?(:TCP_NODELAY)
    socket.setsockopt(::Socket::IPPROTO_TCP, ::Socket::TCP_NODELAY, true)
  end
  socket.setsockopt(::Socket::SOL_SOCKET, ::Socket::SO_KEEPALIVE, true) if options.fetch(:keepalive, true)
  socket.instance_eval do
    @__bunny_socket_eof_flag__ = false
  end
  socket.extend self
  socket.options = { :host => host, :port => port }.merge(options)
  socket
rescue Errno::ETIMEDOUT
  raise ClientTimeout
end

Public Instance Methods

read_fully(count, timeout = nil) click to toggle source

Reads given number of bytes with an optional timeout

@param [Integer] count How many bytes to read @param [Integer] timeout Timeout

@return [String] Data read from the socket @api public

# File lib/bunny/cruby/socket.rb, line 52
def read_fully(count, timeout = nil)
  return nil if @__bunny_socket_eof_flag__

  value = ''
  begin
    loop do
      value << read_nonblock(count - value.bytesize)
      break if value.bytesize >= count
    end
  rescue EOFError
    # @eof will break Rubinius' TCPSocket implementation. MK.
    @__bunny_socket_eof_flag__ = true
  rescue *READ_RETRY_EXCEPTION_CLASSES
    if IO.select([self], nil, nil, timeout)
      retry
    else
      raise Timeout::Error, "IO timeout when reading #{count} bytes"
    end
  end
  value
end
write_nonblock_fully(data, timeout = nil) click to toggle source

Writes provided data using IO#write_nonblock, taking care of handling of exceptions it raises when writing would fail (e.g. due to socket buffer being full).

IMPORTANT: this method will mutate (slice) the argument. Pass in duplicates if this is not appropriate in your case.

@param [String] data Data to write @param [Integer] timeout Timeout

@api public

# File lib/bunny/cruby/socket.rb, line 85
def write_nonblock_fully(data, timeout = nil)
  return nil if @__bunny_socket_eof_flag__

  length = data.bytesize
  total_count = 0
  count = 0
  loop do
    begin
      count = self.write_nonblock(data)
    rescue *WRITE_RETRY_EXCEPTION_CLASSES
      if IO.select([], [self], nil, timeout)
        retry
      else
        raise Timeout::Error, "IO timeout when writing to socket"
      end
    end

    total_count += count
    return total_count if total_count >= length
    data = data.byteslice(count..-1)
  end

end