DVBLink Remote API Library documentation  0.2.0-Master
 All Classes Namespaces Functions Variables Enumerations Enumerator Pages
dvblinkremotehttp::HttpWebResponse Class Reference

Class for defining a HTTP web response. More...

Public Member Functions

 HttpWebResponse (const int statusCode, const std::string &responseData)
 Initializes a new instance of the dvblinkremotehttp::HttpWebResponse class.
 ~HttpWebResponse ()
 Destructor for cleaning up allocated memory.
int GetStatusCode ()
 Gets the HTTP response code.
std::string & GetResponseData ()
 Gets the HTTP response data.

Public Attributes

std::string ContentType
 The HTTP response data MIME type.
long ContentLength
 The HTTP response data length.

Detailed Description

Class for defining a HTTP web response.

This is used as return parameter for the HttpClient::GetResponse method.

See Also
HttpClient::GetResponse()

Constructor & Destructor Documentation

dvblinkremotehttp::HttpWebResponse::HttpWebResponse ( const int  statusCode,
const std::string &  responseData 
)

Initializes a new instance of the dvblinkremotehttp::HttpWebResponse class.

Parameters
statusCodeA constant integer representing the HTTP response code.
responseDataA constant string reference representing the HTTP response data.
dvblinkremotehttp::HttpWebResponse::~HttpWebResponse ( )

Destructor for cleaning up allocated memory.

Member Function Documentation

std::string& dvblinkremotehttp::HttpWebResponse::GetResponseData ( )

Gets the HTTP response data.

Returns
A string reference
int dvblinkremotehttp::HttpWebResponse::GetStatusCode ( )

Gets the HTTP response code.

Returns
An integer value

Member Data Documentation

long dvblinkremotehttp::HttpWebResponse::ContentLength

The HTTP response data length.

std::string dvblinkremotehttp::HttpWebResponse::ContentType

The HTTP response data MIME type.