sf::Http::Request Class Reference

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

#include <Http.hpp>

List of all members.

Public Types
enum	Method {   Get,   Post,   Head }
	Enumerate the available HTTP methods for a request. More...
Public Member Functions
	Request (Method method=Get, const std::string &URI="/", const std::string &body="")
	Default constructor.
void	SetField (const std::string &field, const std::string &value)
	Set the value of a field; the field is added if it doesn't exist.
void	SetMethod (Method method)
	Set the request method.
void	SetURI (const std::string &URI)
	Set the target URI of the request.
void	SetHttpVersion (unsigned int major, unsigned int minor)
	Set the HTTP version of the request.
void	SetBody (const std::string &body)
	Set the body of the request.
Friends
class	Http

---

Detailed Description

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

Definition at line 54 of file Http.hpp.

---

Member Enumeration Documentation

enum sf::Http::Request::Method

Enumerate the available HTTP methods for a request.

Enumerator:

Get	Request in get mode, standard method to retrieve a page.
Post	Request in post mode, usually to send data to a page.
Head	Request a page's header only.

Definition at line 61 of file Http.hpp.

---

Constructor & Destructor Documentation

sf::Http::Request::Request	(	Method	method = Get,
		const std::string &	URI = "/",
		const std::string &	body = ""
	)

Default constructor.

Parameters:

	method	: Method to use for the request
	URI	: Target URI
	body	: Content of the request's body

Definition at line 55 of file Http.cpp.

---

Member Function Documentation

void sf::Http::Request::SetBody

(

const std::string &

body

)

Set the body of the request.

This parameter is optional and makes sense only for POST requests. This parameter is empty by default

Parameters:

body

: Content of the request body

This parameter is optional and makes sense only for POST requests. This parameter is empty by default

Definition at line 113 of file Http.cpp.

void sf::Http::Request::SetField	(	const std::string &	field,
		const std::string &	value
	)

Set the value of a field; the field is added if it doesn't exist.

Parameters:

	field	: Name of the field to set (case-insensitive)
	value	: Value of the field

Definition at line 67 of file Http.cpp.

void sf::Http::Request::SetHttpVersion	(	unsigned int	major,
		unsigned int	minor
	)

Set the HTTP version of the request.

This parameter is 1.0 by default

Parameters:

	major	: Major version number
	minor	: Minor version number

This parameter is 1.0 by default

Definition at line 101 of file Http.cpp.

void sf::Http::Request::SetMethod

(

Method

method

)

Set the request method.

This parameter is Http::Request::Get by default

Parameters:

method

: Method to use for the request

This parameter is Get by default

Definition at line 77 of file Http.cpp.

void sf::Http::Request::SetURI

(

const std::string &

URI

)

Set the target URI of the request.

This parameter is "/" by default

Parameters:

URI

: URI to request, local to the host

This parameter is "/" by default

Definition at line 87 of file Http.cpp.

---

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

• Http.hpp
• Http.cpp