D++ (DPP)  10.0.30
C++ Discord API Bot Library
dpp::http_request_completion_t Struct Reference

The result of any HTTP request. More...

#include "queues.h"

Collaboration diagram for dpp::http_request_completion_t:

Public Attributes

std::string body
 Reply body. More...
 
http_error error = h_success
 Error status. More...
 
std::multimap< std::string, std::string > headers
 HTTP headers of response. More...
 
double latency
 Ping latency. More...
 
std::string ratelimit_bucket
 Ratelimit bucket. More...
 
bool ratelimit_global = false
 True if this request has caused us to be globally rate limited. More...
 
uint64_t ratelimit_limit = 0
 Ratelimit limit of requests. More...
 
uint64_t ratelimit_remaining = 0
 Ratelimit remaining requests. More...
 
uint64_t ratelimit_reset_after = 0
 Ratelimit reset after (seconds). More...
 
uint64_t ratelimit_retry_after = 0
 Ratelimit retry after (seconds). More...
 
uint16_t status = 0
 HTTP status. More...
 

Detailed Description

The result of any HTTP request.

Contains the headers, vital rate limit figures, and returned request body.

Member Data Documentation

◆ body

std::string dpp::http_request_completion_t::body

◆ error

http_error dpp::http_request_completion_t::error = h_success

Error status.

e.g. if the request could not connect at all.

◆ headers

std::multimap<std::string, std::string> dpp::http_request_completion_t::headers

HTTP headers of response.

Referenced by dpp::http_request::http_request().

◆ latency

double dpp::http_request_completion_t::latency

Ping latency.

◆ ratelimit_bucket

std::string dpp::http_request_completion_t::ratelimit_bucket

Ratelimit bucket.

◆ ratelimit_global

bool dpp::http_request_completion_t::ratelimit_global = false

True if this request has caused us to be globally rate limited.

◆ ratelimit_limit

uint64_t dpp::http_request_completion_t::ratelimit_limit = 0

Ratelimit limit of requests.

◆ ratelimit_remaining

uint64_t dpp::http_request_completion_t::ratelimit_remaining = 0

Ratelimit remaining requests.

◆ ratelimit_reset_after

uint64_t dpp::http_request_completion_t::ratelimit_reset_after = 0

Ratelimit reset after (seconds).

◆ ratelimit_retry_after

uint64_t dpp::http_request_completion_t::ratelimit_retry_after = 0

Ratelimit retry after (seconds).

Referenced by dpp::http_request::complete().

◆ status

uint16_t dpp::http_request_completion_t::status = 0

HTTP status.

e.g. 200 = OK, 404 = Not found, 429 = Rate limited, etc.

Referenced by dpp::confirmation_callback_t::confirmation_callback_t(), dpp::http_request::http_request(), and main().


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