Class: Unicorn::StreamInput

Inherits:
Object
  • Object
show all
Defined in:
lib/unicorn/stream_input.rb

Overview

When processing uploads, Unicorn may expose a StreamInput object under “rack.input” of the (future) Rack (2.x) environment.

Direct Known Subclasses

TeeInput

Constant Summary collapse

@@io_chunk_size =

The I/O chunk size (in bytes) for I/O operations where the size cannot be user-specified when a method is called. The default is 16 kilobytes.

Unicorn::Const::CHUNK_SIZE

Instance Method Summary collapse

Constructor Details

#initialize(socket, request) ⇒ StreamInput

Initializes a new StreamInput object. You normally do not have to call this unless you are writing an HTTP server.


13
14
15
16
17
18
19
20
21
# File 'lib/unicorn/stream_input.rb', line 13

def initialize(socket, request)
  @chunked = request.content_length.nil?
  @socket = socket
  @parser = request
  @buf = request.buf
  @rbuf = ''
  @bytes_read = 0
  filter_body(@rbuf, @buf) unless @buf.empty?
end

Instance Method Details

#eachObject

:call-seq:

ios.each { |line| block }  => ios

Executes the block for every “line'' in ios, where lines are separated by the global record separator ($/, typically “n”).


96
97
98
99
100
101
102
# File 'lib/unicorn/stream_input.rb', line 96

def each
  while line = gets
    yield line
  end

  self # Rack does not specify what the return value is here
end

#getsObject

:call-seq:

ios.gets   => string or nil

Reads the next “line'' from the I/O stream; lines are separated by the global record separator ($/, typically “n”). A global record separator of nil reads the entire unread contents of ios. Returns nil if called at the end of file. This takes zero arguments for strict Rack::Lint compatibility, unlike IO#gets.


74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
# File 'lib/unicorn/stream_input.rb', line 74

def gets
  sep = $/
  if sep.nil?
    read_all(rv = '')
    return rv.empty? ? nil : rv
  end
  re = /\A(.*?#{Regexp.escape(sep)})/

  begin
    @rbuf.sub!(re, '') and return $1
    return @rbuf.empty? ? nil : @rbuf.slice!(0, @rbuf.size) if eof?
    @socket.kgio_read(@@io_chunk_size, @buf) or eof!
    filter_body(once = '', @buf)
    @rbuf << once
  end while true
end

#read(length = nil, rv = '') ⇒ Object

:call-seq:

ios.read([length [, buffer ]]) => string, buffer, or nil

Reads at most length bytes from the I/O stream, or to the end of file if length is omitted or is nil. length must be a non-negative integer or nil. If the optional buffer argument is present, it must reference a String, which will receive the data.

At end of file, it returns nil or '' depend on length. ios.read() and ios.read(nil) returns ''. ios.read(length [, buffer]) returns nil.

If the Content-Length of the HTTP request is known (as is the common case for POST requests), then ios.read(length [, buffer]) will block until the specified length is read (or it is the last chunk). Otherwise, for uncommon “Transfer-Encoding: chunked” requests, ios.read(length [, buffer]) will return immediately if there is any data and only block when nothing is available (providing IO#readpartial semantics).


42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
# File 'lib/unicorn/stream_input.rb', line 42

def read(length = nil, rv = '')
  if length
    if length <= @rbuf.size
      length < 0 and raise ArgumentError, "negative length #{length} given"
      rv.replace(@rbuf.slice!(0, length))
    else
      to_read = length - @rbuf.size
      rv.replace(@rbuf.slice!(0, @rbuf.size))
      until to_read == 0 || eof? || (rv.size > 0 && @chunked)
        @socket.kgio_read(to_read, @buf) or eof!
        filter_body(@rbuf, @buf)
        rv << @rbuf
        to_read -= @rbuf.size
      end
      @rbuf.clear
    end
    rv = nil if rv.empty? && length != 0
  else
    read_all(rv)
  end
  rv
end