Azure::Core::Http::RawResponse Class Reference

After receiving and interpreting a request message, a server responds with an HTTP response message.

#include <raw_response.hpp>

Public Member Functions
	RawResponse (int32_t majorVersion, int32_t minorVersion, HttpStatusCode statusCode, std::string const &reasonPhrase)
	Constructs RawResponse.
	RawResponse (RawResponse const &response)
	Constructs RawResponse from another.
	RawResponse (RawResponse &&response)=default
	Constructs RawResponse by moving in another instance.
RawResponse &	operator= (RawResponse const &)=delete
	RawResponse cannot be assigned.
RawResponse &	operator= (RawResponse &&)=delete
	RawResponse cannot be moved into.
	~RawResponse ()=default
	Destructs RawResponse.
void	SetHeader (std::string const &name, std::string const &value)
	Set an HTTP header to the Azure::Core::Http::RawResponse.
void	SetBodyStream (std::unique_ptr< Azure::Core::IO::BodyStream > stream)
	Set Azure::Core::IO::BodyStream for this HTTP response.
void	SetBody (std::vector< uint8_t > body)
	Set HTTP response body for this HTTP response.
int32_t	GetMajorVersion () const
	Get HTTP protocol major version.
int32_t	GetMinorVersion () const
	Get HTTP protocol minor version.
HttpStatusCode	GetStatusCode () const
	Get HTTP status code of the HTTP response.
std::string const &	GetReasonPhrase () const
	Get HTTP reason phrase code of the HTTP response.
CaseInsensitiveMap const &	GetHeaders () const
	Get HTTP response headers.
std::unique_ptr< Azure::Core::IO::BodyStream >	ExtractBodyStream ()
	Get HTTP response body as Azure::Core::IO::BodyStream.
std::vector< uint8_t > &	GetBody ()
	Get HTTP response body as vector of bytes.
std::vector< uint8_t > const &	GetBody () const
	Get HTTP response body as vector of bytes.

Constructor & Destructor Documentation

RawResponse() [1/3]

Azure::Core::Http::RawResponse::RawResponse ( int32_t  majorVersion, int32_t  minorVersion, HttpStatusCode  statusCode, std::string const &  reasonPhrase  )

inlineexplicit

Parameters

majorVersion	HTTP protocol version major number.
minorVersion	HTTP protocol version minor number.
statusCode	HTTP status code.
reasonPhrase	HTTP reason phrase.

RawResponse() [2/3]

Azure::Core::Http::RawResponse::RawResponse ( RawResponse const &  response )

inline

Remarks

The body stream won't be copied.

Parameters

response

A reference for copying the raw response.

RawResponse() [3/3]

Azure::Core::Http::RawResponse::RawResponse ( RawResponse &&  response )

default

Parameters

response

Another RawResponse to move in.

~RawResponse()

Azure::Core::Http::RawResponse::~RawResponse ( )

default

Member Function Documentation

ExtractBodyStream()

std::unique_ptr< Azure::Core::IO::BodyStream > Azure::Core::Http::RawResponse::ExtractBodyStream ( )

inline

GetBody() [1/2]

std::vector< uint8_t > & Azure::Core::Http::RawResponse::GetBody ( )

inline

GetBody() [2/2]

std::vector< uint8_t > const & Azure::Core::Http::RawResponse::GetBody ( ) const

inline

GetHeaders()

CaseInsensitiveMap const & Azure::Core::Http::RawResponse::GetHeaders

(

)

const

GetMajorVersion()

int32_t Azure::Core::Http::RawResponse::GetMajorVersion ( ) const

inline

GetMinorVersion()

int32_t Azure::Core::Http::RawResponse::GetMinorVersion ( ) const

inline

GetReasonPhrase()

std::string const & Azure::Core::Http::RawResponse::GetReasonPhrase

(

)

const

GetStatusCode()

HttpStatusCode Azure::Core::Http::RawResponse::GetStatusCode

(

)

const

operator=() [1/2]

RawResponse & Azure::Core::Http::RawResponse::operator= ( RawResponse &&  )

delete

operator=() [2/2]

RawResponse & Azure::Core::Http::RawResponse::operator= ( RawResponse const &  )

delete

SetBody()

void Azure::Core::Http::RawResponse::SetBody ( std::vector< uint8_t >  body )

inline

Parameters

body	HTTP response body bytes.

SetBodyStream()

void Azure::Core::Http::RawResponse::SetBodyStream

(

std::unique_ptr< Azure::Core::IO::BodyStream >

stream

)

Parameters

stream

Azure::Core::IO::BodyStream.

SetHeader()

void Azure::Core::Http::RawResponse::SetHeader	(	std::string const &	name,
		std::string const &	value
	)

Remarks

The name must contain valid header name characters (RFC 7230).

Parameters

name	The name for the header to be set or added.
value	The value for the header to be set or added.

Exceptions

if	name contains invalid characters.

---

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

• inc/azure/core/http/raw_response.hpp