Class: Excon::Socket
- Inherits:
-
Object
- Object
- Excon::Socket
- Extended by:
- Forwardable
- Defined in:
- lib/excon/socket.rb
Direct Known Subclasses
Instance Attribute Summary collapse
-
#data ⇒ Object
Returns the value of attribute data.
-
#remote_ip ⇒ Object
readonly
Returns the value of attribute remote_ip.
Instance Method Summary collapse
-
#initialize(data = {}) ⇒ Socket
constructor
A new instance of Socket.
- #params ⇒ Object
- #params=(new_params) ⇒ Object
- #read(max_length = nil) ⇒ Object
- #write(data) ⇒ Object
Constructor Details
#initialize(data = {}) ⇒ Socket
Returns a new instance of Socket.
22 23 24 25 26 27 28 29 30 31 32 33 |
# File 'lib/excon/socket.rb', line 22 def initialize(data = {}) @data = data @read_buffer = '' @eof = false @data[:family] ||= ::Socket::Constants::AF_UNSPEC if @data[:proxy] @data[:proxy][:family] ||= ::Socket::Constants::AF_UNSPEC end connect end |
Instance Attribute Details
#data ⇒ Object
Returns the value of attribute data.
6 7 8 |
# File 'lib/excon/socket.rb', line 6 def data @data end |
#remote_ip ⇒ Object (readonly)
Returns the value of attribute remote_ip.
17 18 19 |
# File 'lib/excon/socket.rb', line 17 def remote_ip @remote_ip end |
Instance Method Details
#params ⇒ Object
8 9 10 11 |
# File 'lib/excon/socket.rb', line 8 def params Excon.display_warning("Excon::Socket#params is deprecated use Excon::Socket#data instead (#{caller.first})") @data end |
#params=(new_params) ⇒ Object
12 13 14 15 |
# File 'lib/excon/socket.rb', line 12 def params=(new_params) Excon.display_warning("Excon::Socket#params= is deprecated use Excon::Socket#data= instead (#{caller.first})") @data = new_params end |
#read(max_length = nil) ⇒ Object
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 |
# File 'lib/excon/socket.rb', line 35 def read(max_length=nil) if @eof return nil elsif @data[:nonblock] begin if max_length until @read_buffer.length >= max_length @read_buffer << @socket.read_nonblock(max_length - @read_buffer.length) end else while true @read_buffer << @socket.read_nonblock(@data[:chunk_size]) end end rescue OpenSSL::SSL::SSLError => error if error. == 'read would block' if IO.select([@socket], nil, nil, @data[:read_timeout]) retry else raise(Excon::Errors::Timeout.new("read timeout reached")) end else raise(error) end rescue Errno::EAGAIN, Errno::EWOULDBLOCK, IO::WaitReadable if IO.select([@socket], nil, nil, @data[:read_timeout]) retry else raise(Excon::Errors::Timeout.new("read timeout reached")) end rescue EOFError @eof = true end if max_length @read_buffer.slice!(0, max_length) else # read until EOFError, so return everything @read_buffer.slice!(0, @read_buffer.length) end else begin Timeout.timeout(@data[:read_timeout]) do @socket.read(max_length) end rescue Timeout::Error raise Excon::Errors::Timeout.new('read timeout reached') end end end |
#write(data) ⇒ Object
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 |
# File 'lib/excon/socket.rb', line 85 def write(data) if @data[:nonblock] # We normally return from the return in the else block below, but # we guard that data is still something in case we get weird # values and String#[] returns nil. (This behavior has been observed # in the wild, so this is a simple defensive mechanism) while data begin # I wish that this API accepted a start position, then we wouldn't # have to slice data when there is a short write. written = @socket.write_nonblock(data) rescue OpenSSL::SSL::SSLError => error if error. == 'write would block' if IO.select(nil, [@socket], nil, @data[:write_timeout]) retry else raise(Excon::Errors::Timeout.new("write timeout reached")) end else raise(error) end rescue Errno::EAGAIN, Errno::EWOULDBLOCK, IO::WaitWritable if IO.select(nil, [@socket], nil, @data[:write_timeout]) retry else raise(Excon::Errors::Timeout.new("write timeout reached")) end else # Fast, common case. # The >= seems weird, why would it have written MORE than we # requested. But we're getting some weird behavior when @socket # is an OpenSSL socket, where it seems like it's saying it wrote # more (perhaps due to SSL packet overhead?). # # Pretty weird, but this is a simple defensive mechanism. return if written >= data.size # This takes advantage of the fact that most ruby implementations # have Copy-On-Write strings. Thusly why requesting a subrange # of data, we actually don't copy data because the new string # simply references a subrange of the original. data = data[written, data.size] end end else begin Timeout.timeout(@data[:write_timeout]) do @socket.write(data) end rescue Timeout::Error Excon::Errors::Timeout.new('write timeout reached') end end end |