class SF::Http

• SF::Http
• Reference
• Object

Overview

A HTTP client

SF::Http is a very simple HTTP client that allows you to communicate with a web server. You can retrieve web pages, send data to an interactive resource, download a remote file, etc. The HTTPS protocol is not supported.

The HTTP client is split into 3 classes:

• SF::Http::Request
• SF::Http::Response
• SF::Http

SF::Http::Request builds the request that will be sent to the server. A request is made of:

• a method (what you want to do)
• a target URI (usually the name of the web page or file)
• one or more header fields (options that you can pass to the server)
• an optional body (for POST requests)

SF::Http::Response parse the response from the web server and provides getters to read them. The response contains:

• a status code
• header fields (that may be answers to the ones that you requested)
• a body, which contains the contents of the requested resource

SF::Http provides a simple function, SendRequest, to send a SF::Http::Request and return the corresponding SF::Http::Response from the server.

Usage example:

# Create a new HTTP client
http = SF::Http.new("http://www.sfml-dev.org")

# Prepare a request to get the 'features.php' page
request = SF::Http::Request.new("features.php")

# Send the request
response = http.send_request request

# Check the status code and display the result
status = response.status
if status.ok?
  puts response.body
else
  puts "Error #{response.status}"
end

Included Modules

• SF::NonCopyable

Defined in:

network/obj.cr

Constructors

• .new(host : String, port : Int = 0)

  Construct the HTTP client with the target host

• .new

  Default constructor

Instance Method Summary

• #finalize
• #send_request(request : Http::Request, timeout : Time = Time::Zero) : Http::Response

  Send a HTTP request and return the server's response.

• #set_host(host : String, port : Int = 0)

  Set the target host

Constructor Detail

Instance Method Detail