HTTP::Server

class HTTP::Server

• HTTP::Server
• Reference
• Object

Overview

An HTTP server.

A server is given a handler that receives an HTTP::Server::Context that holds the HTTP::Request to process and must in turn configure and write to an HTTP::Server::Response.

The HTTP::Server::Response object has status and headers properties that can be configured before writing the response body. Once response output is written, changing the status and headers properties has no effect.

The HTTP::Server::Response is also a write-only IO, so all IO methods are available in it.

The handler given to a server can simply be a block that receives an HTTP::Server::Context, or it can be an HTTP::Handler. An HTTP::Handler has an optional next handler, so handlers can be chained. For example, an initial handler may handle exceptions in a subsequent handler and return a 500 status code (see HTTP::ErrorHandler), the next handler might log the incoming request (see HTTP::LogHandler), and the final handler deals with routing and application logic.

Simple Setup

A handler is given with a block.

require "http/server"

server = HTTP::Server.new(8080) do |context|
  context.response.content_type = "text/plain"
  context.response.print "Hello world!"
end

puts "Listening on http://127.0.0.1:8080"
server.listen

With non-localhost bind address

require "http/server"

server = HTTP::Server.new("0.0.0.0", 8080) do |context|
  context.response.content_type = "text/plain"
  context.response.print "Hello world!"
end

puts "Listening on http://0.0.0.0:8080"
server.listen

Add handlers

A series of handlers are chained.

require "http/server"

HTTP::Server.new("127.0.0.1", 8080, [
  HTTP::ErrorHandler.new,
  HTTP::LogHandler.new,
  HTTP::CompressHandler.new,
  HTTP::StaticFileHandler.new("."),
]).listen

Add handlers and block

A series of handlers is chained, the last one being the given block.

require "http/server"

server = HTTP::Server.new("0.0.0.0", 8080,
  [
    HTTP::ErrorHandler.new,
    HTTP::LogHandler.new,
  ]) do |context|
  context.response.content_type = "text/plain"
  context.response.print "Hello world!"
end

server.listen

Defined in:

Class Method Summary

• .build_middleware(handlers, last_handler : Context -> ? = nil)

  Builds all handlers as the middleware for HTTP::Server.

• .new(host : String, port : Int32, handlers : Array(HTTP::Handler), &handler : Context -> )
• .new(port, handlers : Array(HTTP::Handler), &handler : Context -> )
• .new(host : String, port : Int32, &handler : Context -> )
• .new(port, &handler : Context -> )
• .new(host : String, port : Int32, handlers : Array(HTTP::Handler))
• .new(host : String, port : Int32, handler : HTTP::Handler | HTTP::Handler::Proc)
• .new(port, handlers : Array(HTTP::Handler))
• .new(port, handler)

Instance Method Summary

• #bind(reuse_port = false)

  Creates the underlying TCPServer if the doesn't already exist.

• #close

  Gracefully terminates the server.

• #listen(reuse_port = false)

  Starts the server.

• #port

  Returns the TCP port the server is connected to.

• #tls : OpenSSL::SSL::Context::Server?
• #tls=(tls : OpenSSL::SSL::Context::Server?)

Class Method Detail

Instance Method Detail

server = HTTP::Server.new(0) { }
server.bind
server.port # => 12345