| D++ (DPP) C++ Discord API Bot Library

Search
Loading...
Searching...
No Matches
dpp::http_request_completion_t Struct Reference

The result of any HTTP request. Contains the headers, vital rate limit figures, and returned request body. More...

`#include <queues.h>`

Collaboration diagram for dpp::http_request_completion_t:
[legend]

## Public Attributes

std::string | body
| Reply body.
http_error | error = h_success
| Error status. e.g. if the request could not connect at all.
std::multimap< std::string, std::string > | headers
| HTTP headers of response.
double | latency
| Ping latency.
std::string | ratelimit_bucket
| Ratelimit bucket.
bool | ratelimit_global = false
| True if this request has caused us to be globally rate limited.
uint64_t | ratelimit_limit = 0
| Ratelimit limit of requests.
uint64_t | ratelimit_remaining = 0
| Ratelimit remaining requests.
uint64_t | ratelimit_reset_after = 0
| Ratelimit reset after (seconds).
uint64_t | ratelimit_retry_after = 0
| Ratelimit retry after (seconds).
uint16_t | status = 0
| HTTP status. e.g. 200 = OK, 404 = Not found, 429 = Rate limited, etc.

## 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

Reply 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.

## ◆ 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).

## ◆ status

uint16_t dpp::http_request_completion_t::status = 0

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

D++ Library version 9.0.13 D++ Library version 9.0.12 D++ Library version 9.0.11 D++ Library version 9.0.10 D++ Library version 9.0.9 D++ Library version 9.0.8 D++ Library version 9.0.7 D++ Library version 9.0.6 D++ Library version 9.0.5 D++ Library version 9.0.4 D++ Library version 9.0.3 D++ Library version 9.0.2 D++ Library version 9.0.1 D++ Library version 9.0.0 D++ Library version 1.0.2 D++ Library version 1.0.1 D++ Library version 1.0.0