sf::Http Class Reference

This class provides methods for manipulating the HTTP protocol (described in RFC 1945). More...

#include <Http.hpp>

Inheritance diagram for sf::Http:
sf::NonCopyable

List of all members.

Classes

class  Request
 This class wraps an HTTP request, which is basically :

  • a header with a method, a target URI, and a set of field/value pairs
  • an optional body (for POST requests).
More...
class  Response
 This class wraps an HTTP response, which is basically :

  • a header with a status code and a set of field/value pairs
  • a body (the content of the requested resource).
More...

Public Member Functions

 Http ()
 Default constructor.
 Http (const std::string &host, unsigned short port=0)
 Construct the Http instance with the target host.
void SetHost (const std::string &host, unsigned short port=0)
 Set the target host.
Response SendRequest (const Request &request, float timeout=0.f)
 Send a HTTP request and return the server's response.

Detailed Description

This class provides methods for manipulating the HTTP protocol (described in RFC 1945).

It can connect to a website, get its files, send requests, etc.

Definition at line 45 of file Http.hpp.

Constructor & Destructor Documentation

sf::Http::Http (  ) 

Default constructor.

Definition at line 306 of file Http.cpp.

sf::Http::Http ( const std::string &  host,
unsigned short  port = 0 
)

Construct the Http instance with the target host.

Parameters:
host : Web server to connect to
port : Port to use for connection (0 by default -- use the standard port of the protocol used)

Definition at line 317 of file Http.cpp.

Member Function Documentation

Http::Response sf::Http::SendRequest ( const Request &  request,
float  timeout = 0.f 
)

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

You must be connected to a host before sending requests. Any missing mandatory header field will be added with an appropriate value. Warning : this function waits for the server's response and may not return instantly; use a thread if you don't want to block your application.

Parameters:
request : Request to send
timeout : Maximum time to wait, in seconds (0 by default, means no timeout)
Returns:
Server's response

You must be connected to a host before sending requests. Any missing mandatory header field will be added with an appropriate value. Warning : this function waits for the server's response and may not return instantly; use a thread if you don't want to block your application.

Definition at line 365 of file Http.cpp.

void sf::Http::SetHost ( const std::string &  host,
unsigned short  port = 0 
)

Set the target host.

Parameters:
host : Web server to connect to
port : Port to use for connection (0 by default -- use the standard port of the protocol used)

Definition at line 326 of file Http.cpp.

The documentation for this class was generated from the following files: