dpp::http_request Class Reference

A HTTP request. More...

Collaboration diagram for dpp::http_request:

Public Member Functions
	DPP_DEPRECATED ("Please now use dpp::cluster::request_timeout") time_t request_timeout
	How many seconds before the connection is considered failed if not finished. More...
	http_request (const std::string &_endpoint, const std::string &_parameters, http_completion_event completion, const std::string &_postdata="", http_method method=m_get, const std::string &audit_reason="", const std::string &filename="", const std::string &filecontent="", const std::string &filemimetype="", const std::string &http_protocol="1.1")
	Constructor. When constructing one of these objects it should be passed to request_queue::post_request(). More...
	http_request (const std::string &_endpoint, const std::string &_parameters, http_completion_event completion, const std::string &_postdata="", http_method method=m_get, const std::string &audit_reason="", const std::vector< std::string > &filename={}, const std::vector< std::string > &filecontent={}, const std::vector< std::string > &filemimetypes={}, const std::string &http_protocol="1.1")
	Constructor. When constructing one of these objects it should be passed to request_queue::post_request(). More...
	http_request (const std::string &_url, http_completion_event completion, http_method method=m_get, const std::string &_postdata="", const std::string &_mimetype="text/plain", const std::multimap< std::string, std::string > &_headers={}, const std::string &http_protocol="1.1", time_t _request_timeout=5)
	Constructor. When constructing one of these objects it should be passed to request_queue::post_request(). More...
	~http_request ()
	Destroy the http request object. More...
void	complete (const http_request_completion_t &c)
	Call the completion callback, if the request is complete. More...
http_request_completion_t	run (class cluster *owner)
	Execute the HTTP request and mark the request complete. More...
bool	is_completed ()
	Returns true if the request is complete. More...

Public Attributes
std::string	endpoint
	Endpoint name e.g. /api/users. More...
std::string	parameters
	Major and minor parameters. More...
std::string	postdata
	Postdata for POST and PUT. More...
http_method	method
	HTTP method for request. More...
std::string	reason
	Audit log reason for Discord requests, if non-empty. More...
std::vector< std::string >	file_name
	Upload file name (server side). More...
std::vector< std::string >	file_content
	Upload file contents (binary). More...
std::vector< std::string >	file_mimetypes
	Upload file mime types. application/octet-stream if unspecified. More...
std::string	mimetype
	Request mime type. More...
std::multimap< std::string, std::string >	req_headers
	Request headers (non-discord requests only). More...
bool	waiting
	Waiting for rate limit to expire. More...
std::string	protocol
	HTTP protocol. More...

Detailed Description

A HTTP request.

You should instantiate one of these objects via its constructor, and pass a pointer to it into an instance of request_queue. Although you can directly call the run() method of the object and it will make a HTTP call, be aware that if you do this, it will be a BLOCKING call (not asynchronous) and will not respect rate limits, as both of these functions are managed by the request_queue class.

Constructor & Destructor Documentation

http_request() [1/3]

dpp::http_request::http_request	(	const std::string &	_endpoint,
		const std::string &	_parameters,
		http_completion_event	completion,
		const std::string &	_postdata = "",
		http_method	method = m_get,
		const std::string &	audit_reason = "",
		const std::string &	filename = "",
		const std::string &	filecontent = "",
		const std::string &	filemimetype = "",
		const std::string &	http_protocol = "1.1"
	)

Constructor. When constructing one of these objects it should be passed to request_queue::post_request().

Parameters

_endpoint	The API endpoint, e.g. /api/guilds
_parameters	Major and minor parameters for the endpoint e.g. a user id or guild id
completion	completion event to call when done
_postdata	Data to send in POST and PUT requests
method	The HTTP method to use from dpp::http_method
audit_reason	Audit log reason to send, empty to send none
filename	The filename (server side) of any uploaded file
filecontent	The binary content of any uploaded file for the request
filemimetype	The MIME type of any uploaded file for the request
http_protocol	HTTP protocol

http_request() [2/3]

dpp::http_request::http_request	(	const std::string &	_endpoint,
		const std::string &	_parameters,
		http_completion_event	completion,
		const std::string &	_postdata = "",
		http_method	method = m_get,
		const std::string &	audit_reason = "",
		const std::vector< std::string > &	filename = {},
		const std::vector< std::string > &	filecontent = {},
		const std::vector< std::string > &	filemimetypes = {},
		const std::string &	http_protocol = "1.1"
	)

Constructor. When constructing one of these objects it should be passed to request_queue::post_request().

Parameters

_endpoint	The API endpoint, e.g. /api/guilds
_parameters	Major and minor parameters for the endpoint e.g. a user id or guild id
completion	completion event to call when done
_postdata	Data to send in POST and PUT requests
method	The HTTP method to use from dpp::http_method
audit_reason	Audit log reason to send, empty to send none
filename	The filename (server side) of any uploaded file
filecontent	The binary content of any uploaded file for the request
filemimetypes	The MIME type of any uploaded file for the request
http_protocol	HTTP protocol

http_request() [3/3]

dpp::http_request::http_request	(	const std::string &	_url,
		http_completion_event	completion,
		http_method	method = m_get,
		const std::string &	_postdata = "",
		const std::string &	_mimetype = "text/plain",
		const std::multimap< std::string, std::string > &	_headers = {},
		const std::string &	http_protocol = "1.1",
		time_t	_request_timeout = 5
	)

Constructor. When constructing one of these objects it should be passed to request_queue::post_request().

Parameters

_url	Raw HTTP url
completion	completion event to call when done
method	The HTTP method to use from dpp::http_method
_postdata	Data to send in POST and PUT requests
_mimetype	POST data mime type
_headers	HTTP headers to send
http_protocol	HTTP protocol
_request_timeout	How many seconds before the connection is considered failed if not finished

~http_request()

dpp::http_request::~http_request

(

)

Destroy the http request object.

Member Function Documentation

complete()

void dpp::http_request::complete

(

const http_request_completion_t &

c

)

Call the completion callback, if the request is complete.

Parameters

c	callback to call

DPP_DEPRECATED()

dpp::http_request::DPP_DEPRECATED

(

"Please now use dpp::cluster::request_timeout"

)

How many seconds before the connection is considered failed if not finished.

Deprecated:

Please now use dpp::cluster::request_timeout

is_completed()

bool dpp::http_request::is_completed

(

)

Returns true if the request is complete.

run()

http_request_completion_t dpp::http_request::run

(

class cluster *

owner

)

Execute the HTTP request and mark the request complete.

Parameters

owner

creating cluster

Member Data Documentation

endpoint

std::string dpp::http_request::endpoint

Endpoint name e.g. /api/users.

file_content

std::vector<std::string> dpp::http_request::file_content

Upload file contents (binary).

file_mimetypes

std::vector<std::string> dpp::http_request::file_mimetypes

Upload file mime types. application/octet-stream if unspecified.

file_name

std::vector<std::string> dpp::http_request::file_name

Upload file name (server side).

method

http_method dpp::http_request::method

HTTP method for request.

mimetype

std::string dpp::http_request::mimetype

Request mime type.

parameters

std::string dpp::http_request::parameters

Major and minor parameters.

postdata

std::string dpp::http_request::postdata

Postdata for POST and PUT.

protocol

std::string dpp::http_request::protocol

HTTP protocol.

reason

std::string dpp::http_request::reason

Audit log reason for Discord requests, if non-empty.

req_headers

std::multimap<std::string, std::string> dpp::http_request::req_headers

Request headers (non-discord requests only).

waiting

bool dpp::http_request::waiting

Waiting for rate limit to expire.