Class WebRequest

#include <Geode/utils/web.hpp>
classWebRequest{ ... }
No description provided
Examples0
Public static methods0
Public member functions43
geode::utils::web::WebFuturesend(
std::stringmethod
,
std::stringurl
,
geode::Mod*mod
)
No description provided
geode::utils::web::WebFuturepost(
std::stringurl
,
geode::Mod*mod
)
No description provided
geode::utils::web::WebFutureget(
std::stringurl
,
geode::Mod*mod
)
No description provided
geode::utils::web::WebFutureput(
std::stringurl
,
geode::Mod*mod
)
No description provided
geode::utils::web::WebFuturepatch(
std::stringurl
,
geode::Mod*mod
)
No description provided
geode::utils::web::WebResponsesendSync(
std::stringmethod
,
std::stringurl
,
geode::Mod*mod
)
No description provided
geode::utils::web::WebResponsepostSync(
std::stringurl
,
geode::Mod*mod
)
No description provided
geode::utils::web::WebResponsegetSync(
std::stringurl
,
geode::Mod*mod
)
No description provided
geode::utils::web::WebResponseputSync(
std::stringurl
,
geode::Mod*mod
)
No description provided
geode::utils::web::WebResponsepatchSync(
std::stringurl
,
geode::Mod*mod
)
No description provided
geode::utils::web::WebRequest&removeHeader(
std::string_viewname
)
No description provided
geode::utils::web::WebRequest&param(
std::stringname
,
std::stringvalue
)
No description provided
template<integral T>geode::utils::web::WebRequest&param(
std::stringname
,
Tvalue
)
No description provided
geode::utils::web::WebRequest&removeParam(
std::string_viewname
)
No description provided
geode::utils::web::WebRequest&method(
std::stringmethod
)

Sets the request’s method. Overwritten unless set in an interceptor. Generally speaking use get/post/etc. instead.

Parameters

method

Return value
WebRequest&
geode::utils::web::WebRequest&url(
std::stringurl
)

Sets the request’s URL. Overwritten unless set in an interceptor. Generally speaking use get/post/etc. instead.

Parameters

url

Return value
WebRequest&
geode::utils::web::WebRequest&userAgent(
std::stringname
)

Sets the request’s user agent. Defaults to not sending the User-Agent: header.

Parameters

name

Return value
WebRequest&
geode::utils::web::WebRequest&acceptEncoding(
std::stringencodingType
)

Sets the response’s encoding. Valid values include: br, gzip, deflate, … You can set multiple encoding types by calling this method with a comma separated list of the encodings of your choosing. Defaults to not sending an Accept-Encoding: header, and in turn, does not decompress received contents automatically.

Parameters

encodingType

Target response encoding type. An empty string ("") will use all built-in supported encodings.
Return value
WebRequest&
auto req = web::WebRequest()
 .acceptEncoding("gzip, deflate")
 .get(url);
geode::utils::web::WebRequest&timeout(
std::chrono::secondstime
)

Sets the maximum amount of seconds to allow the entire transfer operation to take. The default timeout is 0, which means the request never times out during transfer.

Parameters

time

Return value
WebRequest&
geode::utils::web::WebRequest&downloadRange(
std::pair<std::uint64_t,std::uint64_t>byteRange
)

Sets the target byte range to request. Defaults to receiving the full request.

Parameters

byteRange

a pair of ints, first value is what byte to start from, second value is the last byte to get (both inclusive)
Return value
WebRequest&
geode::utils::web::WebRequest&certVerification(
boolenabled
)

Enable or disables peer verification in SSL handshake. The default is true.

Parameters

enabled

Return value
WebRequest&
geode::utils::web::WebRequest&transferBody(
boolenabled
)

Enables or disabled getting the body of a request. For HTTP(S), this does a HEAD request. For most other protocols it means just not asking to transfer the body data. The default is true.

Parameters

enabled

Return value
WebRequest&
geode::utils::web::WebRequest&followRedirects(
boolenabled
)

Follow HTTP 3xx redirects. The default is true.

Parameters

enabled

Return value
WebRequest&
geode::utils::web::WebRequest&ignoreContentLength(
boolenabled
)

Enables or disables ignoring the content length header. The default is false.

Parameters

enabled

Return value
WebRequest&
geode::utils::web::WebRequest&CABundleContent(
std::stringcontent
)

Sets the Certificate Authority (CA) bundle content. Defaults to sending the Geode CA bundle, found here: https://github.com/geode-sdk/net_libs/blob/main/ca_bundle.h

Parameters

content

Return value
WebRequest&
geode::utils::web::WebRequest&proxyOpts(
geode::utils::web::ProxyOptsproxyOpts
)

Sets the request’s proxy. Defaults to not using a proxy.

Parameters

proxyOpts

Return value
WebRequest&
geode::utils::web::WebRequest&version(
geode::utils::web::HttpVersionhttpVersion
)

Sets the request’s HTTP version. The default is HttpVersion::DEFAULT.

Parameters

httpVersion

Return value
WebRequest&
geode::utils::web::WebRequest&body(
geode::ByteVectorraw
)

Sets the body of the request to a byte vector.

Parameters

raw

The raw bytes to set as the body.
Return value
WebRequest&
geode::utils::web::WebRequest&bodyString(
std::string_viewstr
)

Sets the body of the request to a string.

Parameters

str

The string to set as the body.
Return value
WebRequest&
geode::utils::web::WebRequest&bodyJSON(
matjson::Valueconst&json
)

Sets the body of the request to a json object.

Parameters

json

Return value
WebRequest&
geode::utils::web::WebRequest&bodyMultipart(
geode::utils::web::MultipartFormconst&form
)

Sets the body of the request to a multipart form.

Parameters

form

The multipart form to set as the body.
Return value
WebRequest&
geode::utils::web::WebRequest&onProgress(
std::move_only_function<void (const WebProgress &)>callback
)

Sets the function that will be called when progress is made on the request. This is an alternative to manually polling it via getProgress().

size_tgetID()const

Gets the unique request ID

Return value
size_t
geode::Mod*getMod()const

Gets the mod which owns the request.

Return value
geode::Mod*
geode::ZStringViewgetMethod()const

Gets the request method as a string

Return value
std::string
geode::ZStringViewgetUrl()const

Gets the request URL

Return value
std::string
std::unordered_map<std::vector<std::string>>const&getHeaders()const

Gets the request headers

Return value
std::unordered_map<std::string, std::vector<std::string>>
std::unordered_map<std::string>const&getUrlParams()const

Gets the parameters inside the URL

Return value
std::unordered_map<std::string, std::string>
std::optional<geode::ByteVector>getBody()const

Gets the post body stream

Return value
std::optional<ByteVector>
std::optional<std::chrono::seconds>getTimeout()const

Gets the request timeout in seconds

Return value
std::optional<std::chrono::seconds>
geode::utils::web::HttpVersiongetHttpVersion()const

Gets HTTP versions applied to the request

Return value
HttpVersion
geode::utils::web::WebProgressgetProgress()const

Gets the current progress of the request, if it was sent. Otherwise, default values are returned.

Fields0
Protected member functions0
Protected fields0
Derived classes0