AWS SDK for C++  0.12.9
AWS SDK for C++
Public Member Functions | List of all members
Aws::Http::HttpRequest Class Referenceabstract

#include <HttpRequest.h>

Inheritance diagram for Aws::Http::HttpRequest:
Aws::Http::Standard::StandardHttpRequest

Public Member Functions

 HttpRequest (const URI &uri, HttpMethod method)
 
virtual ~HttpRequest ()
 
virtual HeaderValueCollection GetHeaders () const =0
 
virtual const Aws::StringGetHeaderValue (const char *headerName) const =0
 
virtual void SetHeaderValue (const char *headerName, const Aws::String &headerValue)=0
 
virtual void SetHeaderValue (const Aws::String &headerName, const Aws::String &headerValue)=0
 
virtual void DeleteHeader (const char *headerName)=0
 
virtual void AddContentBody (const std::shared_ptr< Aws::IOStream > &strContent)=0
 
virtual const std::shared_ptr< Aws::IOStream > & GetContentBody () const =0
 
virtual bool HasHeader (const char *name) const =0
 
virtual int64_t GetSize () const =0
 
virtual const Aws::IOStreamFactoryGetResponseStreamFactory () const =0
 
virtual void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)=0
 
URIGetUri ()
 
const URIGetUri () const
 
Aws::String GetURIString (bool includeQueryString=true) const
 
HttpMethod GetMethod () const
 
const Aws::StringGetQueryString () const
 
void CanonicalizeRequest ()
 
QueryStringParameterCollection GetQueryStringParameters () const
 
void AddQueryStringParameter (const char *key, const Aws::String &value)
 
const Aws::StringGetDate () const
 
void SetDate (const Aws::String &value)
 
const Aws::StringGetAccept () const
 
void SetAccept (const Aws::String &value)
 
const Aws::StringGetAcceptCharSet () const
 
void SetAcceptCharSet (const Aws::String &value)
 
const Aws::StringGetAcceptEncoding () const
 
void SetAcceptEncoding (const Aws::String &value)
 
const Aws::StringGetAuthorization () const
 
void SetAuthorization (const Aws::String &value)
 
const Aws::StringGetAwsAuthorization () const
 
void SetAwsAuthorization (const Aws::String &value)
 
const Aws::StringGetAwsSessionToken () const
 
void SetAwsSessionToken (const Aws::String &value)
 
const Aws::StringGetCookie () const
 
void SetCookie (const Aws::String &value)
 
const Aws::StringGetContentLength () const
 
void SetContentLength (const Aws::String &value)
 
const Aws::StringGetContentType () const
 
void SetContentType (const Aws::String &value)
 
const Aws::StringGetUserAgent () const
 
void SetUserAgent (const Aws::String &value)
 
const Aws::StringGetVia () const
 
void SetVia (const Aws::String &value)
 
void SetDataReceivedEventHandler (const DataReceivedEventHandler &dataReceivedEventHandler)
 
void SetDataReceivedEventHandler (DataReceivedEventHandler &&dataReceivedEventHandler)
 
void SetDataSentEventHandler (const DataSentEventHandler &dataSentEventHandler)
 
void SetDataSentEventHandler (DataSentEventHandler &&dataSentEventHandler)
 
const DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
const DataSentEventHandlerGetDataSentEventHandler () const
 

Detailed Description

Abstract class for representing an HttpRequest.

Definition at line 65 of file HttpRequest.h.

Constructor & Destructor Documentation

Aws::Http::HttpRequest::HttpRequest ( const URI uri,
HttpMethod  method 
)
inline

Initializes an HttpRequest object with uri and http method.

Definition at line 71 of file HttpRequest.h.

virtual Aws::Http::HttpRequest::~HttpRequest ( )
inlinevirtual

Definition at line 75 of file HttpRequest.h.

Member Function Documentation

virtual void Aws::Http::HttpRequest::AddContentBody ( const std::shared_ptr< Aws::IOStream > &  strContent)
pure virtual

Adds a content body stream to the request. This stream will be used to send the body to the endpoint.

Implemented in Aws::Http::Standard::StandardHttpRequest.

void Aws::Http::HttpRequest::AddQueryStringParameter ( const char *  key,
const Aws::String value 
)
inline

Adds a query string parameter to the underlying URI by key and value.

Definition at line 171 of file HttpRequest.h.

void Aws::Http::HttpRequest::CanonicalizeRequest ( )
inline

Normalizes the URI for use with signing.

Definition at line 157 of file HttpRequest.h.

virtual void Aws::Http::HttpRequest::DeleteHeader ( const char *  headerName)
pure virtual

Deletes a header from the request by name.

Implemented in Aws::Http::Standard::StandardHttpRequest.

const Aws::String& Aws::Http::HttpRequest::GetAccept ( ) const
inline

Gets accept header.

Definition at line 193 of file HttpRequest.h.

const Aws::String& Aws::Http::HttpRequest::GetAcceptCharSet ( ) const
inline

Gets Accept CharSet header.

Definition at line 207 of file HttpRequest.h.

const Aws::String& Aws::Http::HttpRequest::GetAcceptEncoding ( ) const
inline

Gets accept encoding header.

Definition at line 221 of file HttpRequest.h.

const Aws::String& Aws::Http::HttpRequest::GetAuthorization ( ) const
inline

Gets authorization encoding header.

Definition at line 235 of file HttpRequest.h.

const Aws::String& Aws::Http::HttpRequest::GetAwsAuthorization ( ) const
inline

Gets aws authorization header.

Definition at line 249 of file HttpRequest.h.

const Aws::String& Aws::Http::HttpRequest::GetAwsSessionToken ( ) const
inline

Gets session token header.

Definition at line 263 of file HttpRequest.h.

virtual const std::shared_ptr<Aws::IOStream>& Aws::Http::HttpRequest::GetContentBody ( ) const
pure virtual

Gets the content body stream that will be used for this request.

Implemented in Aws::Http::Standard::StandardHttpRequest.

const Aws::String& Aws::Http::HttpRequest::GetContentLength ( ) const
inline

Gets content-length header.

Definition at line 291 of file HttpRequest.h.

const Aws::String& Aws::Http::HttpRequest::GetContentType ( ) const
inline

Gets content-type header.

Definition at line 305 of file HttpRequest.h.

const Aws::String& Aws::Http::HttpRequest::GetCookie ( ) const
inline

Gets cookie header.

Definition at line 277 of file HttpRequest.h.

const DataReceivedEventHandler& Aws::Http::HttpRequest::GetDataReceivedEventHandler ( ) const
inline

Gets the closure for receiving events when data is received from the server.

Definition at line 363 of file HttpRequest.h.

const DataSentEventHandler& Aws::Http::HttpRequest::GetDataSentEventHandler ( ) const
inline

Gets the closure for receiving events when data is sent to the server.

Definition at line 367 of file HttpRequest.h.

const Aws::String& Aws::Http::HttpRequest::GetDate ( ) const
inline

Gets date header.

Definition at line 179 of file HttpRequest.h.

virtual HeaderValueCollection Aws::Http::HttpRequest::GetHeaders ( ) const
pure virtual

Get All headers for this request.

Implemented in Aws::Http::Standard::StandardHttpRequest.

virtual const Aws::String& Aws::Http::HttpRequest::GetHeaderValue ( const char *  headerName) const
pure virtual

Get the value for a Header based on its name.

Implemented in Aws::Http::Standard::StandardHttpRequest.

HttpMethod Aws::Http::HttpRequest::GetMethod ( ) const
inline

Get the http method for this request.

Definition at line 143 of file HttpRequest.h.

const Aws::String& Aws::Http::HttpRequest::GetQueryString ( ) const
inline

Gets the query string from the URI on this request.

Definition at line 150 of file HttpRequest.h.

QueryStringParameterCollection Aws::Http::HttpRequest::GetQueryStringParameters ( ) const
inline

Gets the query string for the underlying URI as a key value mapping

Definition at line 164 of file HttpRequest.h.

virtual const Aws::IOStreamFactory& Aws::Http::HttpRequest::GetResponseStreamFactory ( ) const
pure virtual

Gets the factory for creating the stream that will be used in the http response.

Implemented in Aws::Http::Standard::StandardHttpRequest.

virtual int64_t Aws::Http::HttpRequest::GetSize ( ) const
pure virtual

Get size in bytes of the request when as it will be going accross the wire.

Implemented in Aws::Http::Standard::StandardHttpRequest.

URI& Aws::Http::HttpRequest::GetUri ( )
inline

Gets underlying URI object with mutation access.

Definition at line 124 of file HttpRequest.h.

const URI& Aws::Http::HttpRequest::GetUri ( ) const
inline

Gets the underlying URI object.

Definition at line 131 of file HttpRequest.h.

Aws::String Aws::Http::HttpRequest::GetURIString ( bool  includeQueryString = true) const
inline

Converts the URI into a string and returns it. If includeQueryString is set to true, the query string will be included in the returned value.

Definition at line 136 of file HttpRequest.h.

const Aws::String& Aws::Http::HttpRequest::GetUserAgent ( ) const
inline

Gets User Agent header.

Definition at line 319 of file HttpRequest.h.

const Aws::String& Aws::Http::HttpRequest::GetVia ( ) const
inline

Gets via header header.

Definition at line 333 of file HttpRequest.h.

virtual bool Aws::Http::HttpRequest::HasHeader ( const char *  name) const
pure virtual

Returns true if a header exists in the request with name

Implemented in Aws::Http::Standard::StandardHttpRequest.

void Aws::Http::HttpRequest::SetAccept ( const Aws::String value)
inline

Gets accept header.

Definition at line 200 of file HttpRequest.h.

void Aws::Http::HttpRequest::SetAcceptCharSet ( const Aws::String value)
inline

Sets Accept CharSet header.

Definition at line 214 of file HttpRequest.h.

void Aws::Http::HttpRequest::SetAcceptEncoding ( const Aws::String value)
inline

Sets accept encoding header.

Definition at line 228 of file HttpRequest.h.

void Aws::Http::HttpRequest::SetAuthorization ( const Aws::String value)
inline

Set authorization header.

Definition at line 242 of file HttpRequest.h.

void Aws::Http::HttpRequest::SetAwsAuthorization ( const Aws::String value)
inline

Sets aws authorization header.

Definition at line 256 of file HttpRequest.h.

void Aws::Http::HttpRequest::SetAwsSessionToken ( const Aws::String value)
inline

Sets session token header.

Definition at line 270 of file HttpRequest.h.

void Aws::Http::HttpRequest::SetContentLength ( const Aws::String value)
inline

Sets content-length header.

Definition at line 298 of file HttpRequest.h.

void Aws::Http::HttpRequest::SetContentType ( const Aws::String value)
inline

sets content-type header.

Definition at line 312 of file HttpRequest.h.

void Aws::Http::HttpRequest::SetCookie ( const Aws::String value)
inline

Sets cookie header.

Definition at line 284 of file HttpRequest.h.

void Aws::Http::HttpRequest::SetDataReceivedEventHandler ( const DataReceivedEventHandler dataReceivedEventHandler)
inline

Sets the closure for receiving events when data is received from the server.

Definition at line 347 of file HttpRequest.h.

void Aws::Http::HttpRequest::SetDataReceivedEventHandler ( DataReceivedEventHandler &&  dataReceivedEventHandler)
inline

Sets the closure for receiving events when data is received from the server.

Definition at line 351 of file HttpRequest.h.

void Aws::Http::HttpRequest::SetDataSentEventHandler ( const DataSentEventHandler dataSentEventHandler)
inline

Sets the closure for receiving events when data is sent to the server.

Definition at line 355 of file HttpRequest.h.

void Aws::Http::HttpRequest::SetDataSentEventHandler ( DataSentEventHandler &&  dataSentEventHandler)
inline

Sets the closure for receiving events when data is sent to the server.

Definition at line 359 of file HttpRequest.h.

void Aws::Http::HttpRequest::SetDate ( const Aws::String value)
inline

Gets date header.

Definition at line 186 of file HttpRequest.h.

virtual void Aws::Http::HttpRequest::SetHeaderValue ( const char *  headerName,
const Aws::String headerValue 
)
pure virtual

Add a header pair

Implemented in Aws::Http::Standard::StandardHttpRequest.

virtual void Aws::Http::HttpRequest::SetHeaderValue ( const Aws::String headerName,
const Aws::String headerValue 
)
pure virtual

Creates a shared_ptr of HttpRequest with uri, method, and closure for how to create a response stream.

Implemented in Aws::Http::Standard::StandardHttpRequest.

virtual void Aws::Http::HttpRequest::SetResponseStreamFactory ( const Aws::IOStreamFactory factory)
pure virtual

Sets the factory for creating the stream that will be used in the http response.

Implemented in Aws::Http::Standard::StandardHttpRequest.

void Aws::Http::HttpRequest::SetUserAgent ( const Aws::String value)
inline

Sets User Agent header.

Definition at line 326 of file HttpRequest.h.

void Aws::Http::HttpRequest::SetVia ( const Aws::String value)
inline

Sets via header.

Definition at line 340 of file HttpRequest.h.


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