libmusicbrainz4  4.0.3
MusicBrainz4::CHTTPFetch Class Reference

Object for make HTTP requests. More...

List of all members.

Public Member Functions

 CHTTPFetch (const std::string &UserAgent, const std::string &Host, int Port=80)
 Constructor.
 ~CHTTPFetch ()
void SetUserName (const std::string &UserName)
 Set the user name to use.
void SetPassword (const std::string &Password)
 Set the password to use.
void SetProxyHost (const std::string &ProxyHost)
 Set the proxy server to use.
void SetProxyPort (int ProxyPort)
 Set the proxy port to use.
void SetProxyUserName (const std::string &ProxyUserName)
 Set the proxy user name to use.
void SetProxyPassword (const std::string &ProxyPassword)
 Set the proxy password to use.
int Fetch (const std::string &URL, const std::string &Request="GET")
 Make a request to the server.
std::vector< unsigned char > Data () const
 Get the data receieved.
int Result () const
 libneon result code from the request
int Status () const
 Status.
std::string ErrorMessage () const
 Return the error message from the request.

Detailed Description

Object to be used to make HTTP requests


Constructor & Destructor Documentation

MusicBrainz4::CHTTPFetch::CHTTPFetch ( const std::string &  UserAgent,
const std::string &  Host,
int  Port = 80 
)

Constructor

Parameters:
UserAgentUser agent string to send
HostHost name to connect to
PortPort to connect to (80 by default)

Member Function Documentation

std::vector<unsigned char> MusicBrainz4::CHTTPFetch::Data ( ) const

Get the data received from the request

Returns:
Data received

Return the error message from the request

Returns:
Error message from the request
int MusicBrainz4::CHTTPFetch::Fetch ( const std::string &  URL,
const std::string &  Request = "GET" 
)

Make a request to the server

Parameters:
URLURL to request
RequestRequest type (GET by default)
Returns:
Number of bytes received
Exceptions:
CConnectionErrorAn error occurred connecting to the web server
CTimeoutErrorA timeout occurred when connecting to the web server
CAuthenticationErrorAn authentication error occurred
CFetchErrorAn error occurred fetching data
CRequestErrorThe request was invalid
CResourceNotFoundErrorThe requested resource was not found

Return the result code from the request

Returns:
libneon result code from the request
void MusicBrainz4::CHTTPFetch::SetPassword ( const std::string &  Password)

Set the password to use when authenticating with the web server

Parameters:
PasswordPassword to use
void MusicBrainz4::CHTTPFetch::SetProxyHost ( const std::string &  ProxyHost)

Set the proxy server to use when connecting with the web server

Parameters:
ProxyHostProxy server to use
void MusicBrainz4::CHTTPFetch::SetProxyPassword ( const std::string &  ProxyPassword)

Set the password to use when authenticating with the proxy server

Parameters:
ProxyPasswordProxy server password to use
void MusicBrainz4::CHTTPFetch::SetProxyPort ( int  ProxyPort)

Set the proxy server port to use when connecting to the web server

Parameters:
ProxyPortProxy server port to use
void MusicBrainz4::CHTTPFetch::SetProxyUserName ( const std::string &  ProxyUserName)

Set the user name to use when authenticating with the proxy server

Parameters:
ProxyUserNameProxy user name to use
void MusicBrainz4::CHTTPFetch::SetUserName ( const std::string &  UserName)

Set the user name to use when authenticating with the web server

Parameters:
UserNameUser name to use

Return the HTTP status code from the request

Returns:
HTTP status code from the request
 All Classes Namespaces Files Functions Typedefs Enumerations Enumerator Defines