All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | List of all members
Eegeo::Web::WebRequest Class Reference

A (largely) immutable class that represents a user-facing web request. More...

#include <WebRequest.h>

Inheritance diagram for Eegeo::Web::WebRequest:
Eegeo::Web::IWebLoadRequest Eegeo::NonCopyable

Public Member Functions

 WebRequest (const TWebRequestId requestId, Eegeo::Web::IWebRequestService &m_webRequestService, const HttpVerbs::Values httpVerb, const std::string &url, IWebLoadRequestCompletionCallback &callback, void *const pUserData, const WebPostData postBodyData, const std::string &userAgent, const int retryLimit, const int timeoutInSeconds, const std::map< std::string, std::string > httpRequestHeaders, const std::map< std::string, WebPostData > httpPostData, const bool shouldCacheAggressively, const bool cacheOnly, const bool shouldCacheResponse, const std::vector< std::string > &acceptableMimeTypes, const std::vector< std::string > &requiredResponseHeaders)
 
void Load ()
 
void Cancel ()
 
HttpVerbs::Values GetHttpVerb () const
 
std::string GetUrl () const
 
IWebLoadRequestCompletionCallbackGetCallback () const
 
void * GetUserData () const
 
const WebPostDataGetPostBodyData () const
 
std::string GetUserAgent () const
 
int GetRetryLimit () const
 
int GetTimeoutInSeconds () const
 
const std::map< std::string,
std::string > & 
GetHttpRequestHeaders () const
 
const std::map< std::string,
WebPostData > & 
GetHttpPostData () const
 
TWebRequestId GetRequestId () const
 
bool ShouldCacheAggressively () const
 
bool CacheOnly () const
 
bool ShouldCacheResponse () const
 
const std::vector< std::string > & GetAcceptableMimeTypes () const
 
const std::vector< std::string > & GetRequiredResponseHeaders () const
 

Additional Inherited Members

- Private Member Functions inherited from Eegeo::NonCopyable
 NonCopyable (const NonCopyable &)=delete
 
NonCopyableoperator= (const NonCopyable &)=delete
 

Detailed Description

A (largely) immutable class that represents a user-facing web request.

Its sole responsibility is to allow the user to enqueue or cancel the request. We should avoid mutating this, or adding more mutable fields.


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