core::net::http::Request::Configuration Struct Reference

The Configuration struct encapsulates all options for creating requests. More...

#include <request.h>

Collaboration diagram for core::net::http::Request::Configuration:

Static Public Member Functions
static Configuration	from_uri_as_string (const std::string &uri)
	from_uri_as_string creates a new instance of Configuration for a url. More...

Public Attributes
std::string	uri
Header	header
ProgressHandler	on_progress
ResponseHandler	on_response
ErrorHandler	on_error
struct {
bool   verify_peer
bool   verify_host
}	ssl
struct {
AuthenicationHandler   for_http
AuthenicationHandler   for_proxy
}	authentication_handler

Detailed Description

The Configuration struct encapsulates all options for creating requests.

Definition at line 161 of file request.h.

Member Function Documentation

static Configuration core::net::http::Request::Configuration::from_uri_as_string ( const std::string &  uri )

inlinestatic

from_uri_as_string creates a new instance of Configuration for a url.

Parameters

uri	The url of the web resource to issue a request for.

Returns

A new Configuration instance.

Definition at line 168 of file request.h.

References uri.

Member Data Documentation

struct { ... } core::net::http::Request::Configuration::authentication_handler

Encapsulates proxy and http authentication handlers.

AuthenicationHandler core::net::http::Request::Configuration::for_http

Invoked for querying user credentials to do basic/digest auth.

Definition at line 211 of file request.h.

AuthenicationHandler core::net::http::Request::Configuration::for_proxy

Invoked for querying user credentials to authenticate proxy accesses.

Definition at line 213 of file request.h.

Header core::net::http::Request::Configuration::header

Custom header fields that are added to the request.

Definition at line 180 of file request.h.

ErrorHandler core::net::http::Request::Configuration::on_error

Invoked to report a request that finished with an error.

Definition at line 189 of file request.h.

ProgressHandler core::net::http::Request::Configuration::on_progress

Invoked to report progress.

Definition at line 183 of file request.h.

ResponseHandler core::net::http::Request::Configuration::on_response

Invoked to report a successfully finished request.

Definition at line 186 of file request.h.

struct { ... } core::net::http::Request::Configuration::ssl

SSL-specific options. Please be very careful when adjusting these.

std::string core::net::http::Request::Configuration::uri

Uri of the web resource to issue a request for.

Definition at line 177 of file request.h.

Referenced by from_uri_as_string().

bool core::net::http::Request::Configuration::verify_host

Initial value:

{
                true
            }

Yes, we want to be strict and verify the host by default, too.

Definition at line 202 of file request.h.

bool core::net::http::Request::Configuration::verify_peer

Initial value:

{
                true
            }

Yes, we want to verify our peer by default.

Definition at line 196 of file request.h.

---

The documentation for this struct was generated from the following file:

• /build/net-cpp-wObqh_/net-cpp-2.0.0/include/core/net/http/request.h