Class: Excon::Socket

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
Utils
Defined in:
lib/excon/socket.rb

Direct Known Subclasses

SSLSocket, UnixSocket

Constant Summary

Constants included from Utils

Utils::CONTROL, Utils::DELIMS, Utils::ESCAPED, Utils::NONASCII, Utils::UNESCAPED, Utils::UNWISE

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Utils

#connection_uri, #escape_uri, #port_string, #query_string, #request_uri, #split_header_value, #unescape_form, #unescape_uri

Constructor Details

#initialize(data = {}) ⇒ Socket

Returns a new instance of Socket.



24
25
26
27
28
29
30
 
# File 'lib/excon/socket.rb', line 24

def initialize(data = {})
  @data = data
  @nonblock = data[:nonblock]
  @read_buffer = String.new
  @eof = false
  connect
end

Instance Attribute Details

#data ⇒ Object

Returns the value of attribute data.



8
9
10
 
# File 'lib/excon/socket.rb', line 8

def data
  @data
end

#remote_ip ⇒ Object (readonly)

Returns the value of attribute remote_ip.



20
21
22
 
# File 'lib/excon/socket.rb', line 20

def remote_ip
  @remote_ip
end

Instance Method Details

#legacy_readline ⇒ Object 



59
60
61
62
63
64
65
66
67
 
# File 'lib/excon/socket.rb', line 59

def legacy_readline
  begin
    Timeout.timeout(@data[:read_timeout]) do
      @socket.readline
    end
  rescue Timeout::Error
    raise Excon::Errors::Timeout.new('read timeout reached')
  end
end

#local_address ⇒ Object 



77
78
79
 
# File 'lib/excon/socket.rb', line 77

def local_address
  unpacked_sockaddr[1]
end

#local_port ⇒ Object 



81
82
83
 
# File 'lib/excon/socket.rb', line 81

def local_port
  unpacked_sockaddr[0]
end

#params ⇒ Object 



10
11
12
13
 
# File 'lib/excon/socket.rb', line 10

def params
  Excon.display_warning('Excon::Socket#params is deprecated use Excon::Socket#data instead.')
  @data
end

#params=(new_params) ⇒ Object 



15
16
17
18
 
# File 'lib/excon/socket.rb', line 15

def params=(new_params)
  Excon.display_warning('Excon::Socket#params= is deprecated use Excon::Socket#data= instead.')
  @data = new_params
end

#read(max_length = nil) ⇒ Object 



32
33
34
35
36
37
38
39
40
 
# File 'lib/excon/socket.rb', line 32

def read(max_length = nil)
  if @eof
    return max_length ? nil : ''
  elsif @nonblock
    read_nonblock(max_length)
  else
    read_block(max_length)
  end
end

#readline ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/excon/socket.rb', line 42

def readline
  return legacy_readline if RUBY_VERSION.to_f <= 1.8_7
  buffer = String.new
  begin
    buffer << @socket.read_nonblock(1) while buffer[-1] != "\n"
    buffer
  rescue Errno::EAGAIN, Errno::EWOULDBLOCK, IO::WaitReadable
    select_with_timeout(@socket, :read) && retry
  rescue OpenSSL::SSL::SSLError => error
    if error.message == 'read would block'
      select_with_timeout(@socket, :read) && retry
    else
      raise(error)
    end
  end
end

#write(data) ⇒ Object 



69
70
71
72
73
74
75
 
# File 'lib/excon/socket.rb', line 69

def write(data)
  if @nonblock
    write_nonblock(data)
  else
    write_block(data)
  end
end