123456789_123456789_123456789_123456789_123456789_

Class: Unicorn::StreamInput

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Subclasses:
TeeInput
Inherits: Object
Defined in: lib/unicorn/stream_input.rb

Overview

When processing uploads, unicorn may expose a StreamInput object under “rack.input” of the Rack environment when Configurator#rewindable_input is set to false

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(socket, request) ⇒ StreamInput

This method is for internal use only.

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

[ GitHub ] 

  


# File 'lib/unicorn/stream_input.rb', line 15



def initialize(socket, request) # :nodoc:
  @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 Attribute Details



  

    #eof?  ⇒ Boolean  (readonly, private)
  

  [ GitHub ]


  

  


# File 'lib/unicorn/stream_input.rb', line 110



def eof?
  if @parser.body_eof?
    while @chunked && ! @parser.parse
      @buf << @socket.readpartial(@@io_chunk_size)
    end
    @socket = nil
    true
  else
    false
  end
rescue EOFError
  return eof!
end


  







Instance Method Details



  

    #each {|line| ... } ⇒ IO   



  

    

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


  



  [ GitHub ]


  

  


# File 'lib/unicorn/stream_input.rb', line 100



def each
  while line = gets
    yield line
  end

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


  








  

    #eof!   (private)
  

  [ GitHub ]


  

  


# File 'lib/unicorn/stream_input.rb', line 143



def eof!
  # in case client only did a premature shutdown(SHUT_WR)
  # we do support clients that shutdown(SHUT_WR) after the
  # _entire_ request has been sent, and those will not have
  # raised EOFError on us.
  @socket.shutdown if @socket
ensure
  raise Unicorn::ClientShutdown, "bytes_read=#{@bytes_read}", []
end


  








  

    #filter_body(dst, src)   (private)
  

  [ GitHub ]


  

  


# File 'lib/unicorn/stream_input.rb', line 124



def filter_body(dst, src)
  rv = @parser.filter_body(dst, src)
  @bytes_read += dst.size
  rv
end


  








  

    #gets  ⇒ String?   



  

    

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.


  



  [ GitHub ]


  

  


# File 'lib/unicorn/stream_input.rb', line 77



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?
    filter_body(once = '', @socket.readpartial(@@io_chunk_size, @buf))
    @rbuf << once
  rescue EOFError
    return eof!
  end while true
end


  








  

    #read([length [, buffer ]])  ⇒ String, ...   



  

    

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).


  



  [ GitHub ]


  

  


# File 'lib/unicorn/stream_input.rb', line 44



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)
        filter_body(@rbuf, @socket.readpartial(to_read, @buf))
        rv << @rbuf
        to_read -= @rbuf.size
      end
      @rbuf.clear
    end
    rv = nil if rv.empty? && length != 0
  else
    read_all(rv)
  end
  rv
rescue EOFError
  return eof!
end


  








  

    #read_all(dst)   (private)
  

  [ GitHub ]


  

  


# File 'lib/unicorn/stream_input.rb', line 130



def read_all(dst)
  dst.replace(@rbuf)
  @socket or return
  until eof?
    filter_body(@rbuf, @socket.readpartial(@@io_chunk_size, @buf))
    dst << @rbuf
  end
rescue EOFError
  return eof!
ensure
  @rbuf.clear
end