reference

This documentation is automatically generated from the openFrameworks source code using doxygen and refers to the most recent release, version 0.12.0.

an HTTP GET or POST request More...

#include <ofURLFileLoader.h>

Public Types

enum  Method { GET , POST }
 HTTP request type. More...
 

Public Member Functions

 ofHttpRequest ()
 
 ofHttpRequest (const std::string &url, const std::string &name, bool saveTo=false)
 
int getId () const
 
 OF_DEPRECATED_MSG ("Use getId().", int getID())
 

Public Attributes

std::string url
 request url
 
std::string name
 optional name key for sorting
 
bool saveTo
 save to a file once the request is finised?
 
std::map< std::string, std::string > headers
 HTTP header keys & values.
 
std::string body
 POST body data.
 
std::string contentType
 POST data mime type.
 
std::function< void(const ofHttpResponse &)> done
 
size_t timeoutSeconds = 0
 
enum ofHttpRequest::Method method
 

Detailed Description

an HTTP GET or POST request

Member Enumeration Documentation

◆ Method

HTTP request type.

Enumerator
GET 

request data from a specified resource (via url)

POST 

submit data to be processed to a specified resource (via url)

Constructor & Destructor Documentation

◆ ofHttpRequest() [1/2]

ofHttpRequest::ofHttpRequest ( )

◆ ofHttpRequest() [2/2]

ofHttpRequest::ofHttpRequest ( const std::string &  url,
const std::string &  name,
bool  saveTo = false 
)

Member Function Documentation

◆ getId()

int ofHttpRequest::getId ( ) const
Returns
the unique id for this request

◆ OF_DEPRECATED_MSG()

ofHttpRequest::OF_DEPRECATED_MSG ( "Use getId()."  ,
int   getID() 
)

Member Data Documentation

◆ body

std::string ofHttpRequest::body

POST body data.

◆ contentType

std::string ofHttpRequest::contentType

POST data mime type.

◆ done

std::function<void(const ofHttpResponse&)> ofHttpRequest::done

◆ headers

std::map<std::string,std::string> ofHttpRequest::headers

HTTP header keys & values.

◆ method

enum ofHttpRequest::Method ofHttpRequest::method

◆ name

std::string ofHttpRequest::name

optional name key for sorting

◆ saveTo

bool ofHttpRequest::saveTo

save to a file once the request is finised?

◆ timeoutSeconds

size_t ofHttpRequest::timeoutSeconds = 0

◆ url

std::string ofHttpRequest::url

request url


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