Class: PhusionPassenger::MessageChannel
- Defined in:
- lib/phusion_passenger/message_channel.rb
Overview
This class allows reading and writing structured messages over I/O channels. This is the Ruby implementation of ext/common/Utils/MessageIO.h; see that file for more information.
Defined Under Namespace
Classes: InvalidHashError
Constant Summary collapse
- HEADER_SIZE =
:nodoc:
2
- DELIMITER =
:nodoc:
"\0"
- DELIMITER_NAME =
:nodoc:
"null byte"
- UINT16_PACK_FORMAT =
:nodoc:
"n"
- UINT32_PACK_FORMAT =
:nodoc:
"N"
Instance Attribute Summary collapse
-
#io ⇒ Object
The wrapped IO object.
Instance Method Summary collapse
-
#close ⇒ Object
Close the underlying IO stream.
-
#closed? ⇒ Boolean
Checks whether the underlying IO stream is closed.
-
#fileno ⇒ Object
Return the file descriptor of the underlying IO object.
-
#initialize(io = nil) ⇒ MessageChannel
constructor
Create a new MessageChannel by wrapping the given IO object.
-
#read ⇒ Object
Read an array message from the underlying file descriptor.
-
#read_hash ⇒ Object
Read an array message from the underlying file descriptor and return the result as a hash instead of an array.
-
#read_scalar(buffer = new_buffer, max_size = nil) ⇒ Object
Read a scalar message from the underlying IO object.
-
#recv_io(klass = IO, negotiate = true) ⇒ Object
Receive an IO object (a file descriptor) from the channel.
-
#send_io(io) ⇒ Object
Send an IO object (a file descriptor) over the channel.
-
#write(name, *args) ⇒ Object
Send an array message, which consists of the given elements, over the underlying file descriptor.
-
#write_scalar(data) ⇒ Object
Send a scalar message over the underlying IO object.
Constructor Details
#initialize(io = nil) ⇒ MessageChannel
Create a new MessageChannel by wrapping the given IO object.
44 45 46 47 48 |
# File 'lib/phusion_passenger/message_channel.rb', line 44 def initialize(io = nil) @io = io # Make it binary just in case. @io.binmode if @io end |
Instance Attribute Details
#io ⇒ Object
The wrapped IO object.
41 42 43 |
# File 'lib/phusion_passenger/message_channel.rb', line 41 def io @io end |
Instance Method Details
#close ⇒ Object
Close the underlying IO stream. Might raise SystemCallError or IOError when something goes wrong.
316 317 318 |
# File 'lib/phusion_passenger/message_channel.rb', line 316 def close @io.close end |
#closed? ⇒ Boolean
Checks whether the underlying IO stream is closed.
321 322 323 |
# File 'lib/phusion_passenger/message_channel.rb', line 321 def closed? return @io.closed? end |
#fileno ⇒ Object
Return the file descriptor of the underlying IO object.
310 311 312 |
# File 'lib/phusion_passenger/message_channel.rb', line 310 def fileno return @io.fileno end |
#read ⇒ Object
Read an array message from the underlying file descriptor. Returns the array message as an array, or nil when end-of-stream has been reached.
Might raise SystemCallError, IOError or SocketError when something goes wrong.
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 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 |
# File 'lib/phusion_passenger/message_channel.rb', line 56 def read buffer = new_buffer if !@io.read(HEADER_SIZE, buffer) return nil end while buffer.size < HEADER_SIZE tmp = @io.read(HEADER_SIZE - buffer.size) if tmp.empty? return nil else buffer << tmp end end chunk_size = buffer.unpack(UINT16_PACK_FORMAT)[0] if !@io.read(chunk_size, buffer) return nil end while buffer.size < chunk_size tmp = @io.read(chunk_size - buffer.size) if tmp.empty? return nil else buffer << tmp end end = [] offset = 0 delimiter_pos = buffer.index(DELIMITER, offset) while !delimiter_pos.nil? if delimiter_pos == 0 << "" else << buffer[offset .. delimiter_pos - 1] end offset = delimiter_pos + 1 delimiter_pos = buffer.index(DELIMITER, offset) end return rescue Errno::ECONNRESET return nil end |
#read_hash ⇒ Object
Read an array message from the underlying file descriptor and return the result as a hash instead of an array. This assumes that the array message has an even number of elements. Returns nil when end-of-stream has been reached.
Might raise SystemCallError, IOError or SocketError when something goes wrong.
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 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'lib/phusion_passenger/message_channel.rb', line 107 def read_hash buffer = new_buffer if !@io.read(HEADER_SIZE, buffer) return nil end while buffer.size < HEADER_SIZE tmp = @io.read(HEADER_SIZE - buffer.size) if tmp.empty? return nil else buffer << tmp end end chunk_size = buffer.unpack(UINT16_PACK_FORMAT)[0] if !@io.read(chunk_size, buffer) return nil end while buffer.size < chunk_size tmp = @io.read(chunk_size - buffer.size) if tmp.empty? return nil else buffer << tmp end end result = {} offset = 0 delimiter_pos = buffer.index(DELIMITER, offset) while !delimiter_pos.nil? if delimiter_pos == 0 name = "" else name = buffer[offset .. delimiter_pos - 1] end offset = delimiter_pos + 1 delimiter_pos = buffer.index(DELIMITER, offset) if delimiter_pos.nil? raise InvalidHashError elsif delimiter_pos == 0 value = "" else value = buffer[offset .. delimiter_pos - 1] end result[name] = value offset = delimiter_pos + 1 delimiter_pos = buffer.index(DELIMITER, offset) end return result rescue Errno::ECONNRESET return nil end |
#read_scalar(buffer = new_buffer, max_size = nil) ⇒ Object
Read a scalar message from the underlying IO object. Returns the read message, or nil on end-of-stream.
Might raise SystemCallError, IOError or SocketError when something goes wrong.
The buffer
argument specifies a buffer in which #read_scalar stores the read data. It is good practice to reuse existing buffers in order to minimize stress on the garbage collector.
The max_size
argument allows one to specify the maximum allowed size for the scalar message. If the received scalar message’s size is larger than max_size
, then a SecurityError will be raised.
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 |
# File 'lib/phusion_passenger/message_channel.rb', line 176 def read_scalar(buffer = new_buffer, max_size = nil) if !@io.read(4, buffer) return nil end while buffer.size < 4 tmp = @io.read(4 - buffer.size) if tmp.empty? return nil else buffer << tmp end end size = buffer.unpack(UINT32_PACK_FORMAT)[0] if size == 0 buffer.replace('') return buffer else if !max_size.nil? && size > max_size raise SecurityError, "Scalar message size (#{size}) " << "exceeds maximum allowed size (#{max_size})." end if !@io.read(size, buffer) return nil end if buffer.size < size tmp = '' while buffer.size < size if !@io.read(size - buffer.size, tmp) return nil else buffer << tmp end end end return buffer end rescue Errno::ECONNRESET return nil end |
#recv_io(klass = IO, negotiate = true) ⇒ Object
Receive an IO object (a file descriptor) from the channel. The other side must have sent an IO object by calling send_io(). Note that this only works on Unix sockets.
Might raise SystemCallError, IOError or SocketError when something goes wrong.
253 254 255 256 257 258 |
# File 'lib/phusion_passenger/message_channel.rb', line 253 def recv_io(klass = IO, negotiate = true) write("pass IO") if negotiate io = @io.recv_io(klass) write("got IO") if negotiate return io end |
#send_io(io) ⇒ Object
Send an IO object (a file descriptor) over the channel. The other side must receive the IO object by calling recv_io(). Note that this only works on Unix sockets.
Might raise SystemCallError, IOError or SocketError when something goes wrong.
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 |
# File 'lib/phusion_passenger/message_channel.rb', line 266 def send_io(io) # We read a message before actually calling #send_io # in order to prevent the other side from accidentally # read()ing past the normal data and reading our file # descriptor too. # # For example suppose that side A looks like this: # # read(fd, buf, 1024) # read_io(fd) # # and side B: # # write(fd, buf, 100) # send_io(fd_to_pass) # # If B completes both write() and send_io(), then A's read() call # reads past the 100 bytes that B sent. On some platforms, like # Linux, this will cause read_io() to fail. And it just so happens # that Ruby's IO#read method slurps more than just the given amount # of bytes. result = read if !result raise EOFError, "End of stream" elsif result != ["pass IO"] raise IOError, "IO passing pre-negotiation header expected" else @io.send_io(io) # Once you've sent the IO you expect to be able to close it on the # sender's side, even if the other side hasn't read the IO yet. # Not so: on some operating systems (I'm looking at you OS X) this # can cause the receiving side to receive a bad file descriptor. # The post negotiation protocol ensures that we block until the # other side has really received the IO. result = read if !result raise EOFError, "End of stream" elsif result != ["got IO"] raise IOError, "IO passing post-negotiation header expected" end end end |
#write(name, *args) ⇒ Object
Send an array message, which consists of the given elements, over the underlying file descriptor. name is the first element in the message, and args are the other elements. These arguments will internally be converted to strings by calling to_s().
Might raise SystemCallError, IOError or SocketError when something goes wrong.
224 225 226 227 228 229 230 231 232 233 234 235 236 |
# File 'lib/phusion_passenger/message_channel.rb', line 224 def write(name, *args) check_argument(name) args.each do |arg| check_argument(arg) end = "#{name}#{DELIMITER}" args.each do |arg| << arg.to_s << DELIMITER end @io.write([.size].pack('n') << ) @io.flush end |
#write_scalar(data) ⇒ Object
Send a scalar message over the underlying IO object.
Might raise SystemCallError, IOError or SocketError when something goes wrong.
242 243 244 245 |
# File 'lib/phusion_passenger/message_channel.rb', line 242 def write_scalar(data) @io.write([data.size].pack('N') << data) @io.flush end |