class HTTP::Request

• HTTP::Request
• Reference
• Object

Overview

An HTTP request.

It serves both to perform requests by an HTTP::Client and to represent requests received by an HTTP::Server.

A request always holds an IO as a body. When creating a request with a String or Bytes its body will be a IO::Memory wrapping these, and the Content-Length header will be set appropriately.

NOTE To use Request, you must explicitly import it with require "http/request"

Defined in:

Constructors

• .new(method : String, resource : String, headers : Headers | Nil = nil, body : String | Bytes | IO | Nil = nil, version = "HTTP/1.1")

Class Method Summary

• .from_io(io, *, max_request_line_size : Int32 = HTTP::MAX_REQUEST_LINE_SIZE, max_headers_size : Int32 = HTTP::MAX_HEADERS_SIZE) : HTTP::Request | HTTP::Status | Nil

  Returns a HTTP::Request instance if successfully parsed, nil on EOF or HTTP::Status otherwise.

Instance Method Summary

• #body : IO | Nil
• #body=(body : String)
• #body=(body : Bytes)
• #body=(body : IO)
• #body=(body : Nil)
• #content_length
• #content_length=(length : Int)
• #cookies : HTTP::Cookies

  Returns a convenience wrapper around querying and setting cookie related headers, see HTTP::Cookies.

• #form_params : HTTP::Params

  Returns a convenience wrapper to parse form params, see URI::Params.

• #form_params? : HTTP::Params | Nil

  Returns a convenience wrapper to parse form params, see URI::Params.

• #headers : Headers
• #headers=(headers : Headers)
• #host_with_port : String | Nil

  Returns request host with port from headers.

  DEPRECATED Use headers["Host"]? instead.

• #hostname : String | Nil

  Extracts the hostname from Host header.

• #if_match : Array(String) | Nil
• #if_none_match : Array(String) | Nil
• #ignore_body? : Bool
• #keep_alive? : Bool
• #local_address : Socket::Address | Nil

  The network address of the HTTP server.

• #local_address=(local_address : Socket::Address | Nil)

  The network address of the HTTP server.

• #method : String
• #method=(method : String)
• #path : String

  Returns the request's path component.

• #path=(path)

  Sets request's path component.

• #query : String | Nil

  Lazily parses and returns the request's query component.

• #query=(value)

  Sets request's query component.

• #query_params : URI::Params

  Returns a convenience wrapper around querying and setting query params, see URI::Params.

• #remote_address : Socket::Address | Nil

  The network address that sent the request to an HTTP server.

• #remote_address=(remote_address : Socket::Address | Nil)

  The network address that sent the request to an HTTP server.

• #resource : String
• #to_io(io)
• #version : String
• #version=(version : String)

Constructor Detail

Class Method Detail

Instance Method Detail

class ForwarderHandler
  include HTTP::Handler

  def call(context)
    if ip = context.request.headers["X-Real-IP"]? # When using a reverse proxy that guarantees this field.
      context.request.remote_address = Socket::IPAddress.new(ip, 0)
    end
    call_next(context)
  end
end

server = HTTP::Server.new([ForwarderHandler.new, HTTP::LogHandler.new])

class ForwarderHandler
  include HTTP::Handler

  def call(context)
    if ip = context.request.headers["X-Real-IP"]? # When using a reverse proxy that guarantees this field.
      context.request.remote_address = Socket::IPAddress.new(ip, 0)
    end
    call_next(context)
  end
end

server = HTTP::Server.new([ForwarderHandler.new, HTTP::LogHandler.new])