JUCE
|
Class used to create a set of options to pass to the createInputStream() method. More...
#include <juce_URL.h>
Public Member Functions | |
InputStreamOptions (ParameterHandling parameterHandling) | |
Constructor. | |
JUCE_NODISCARD InputStreamOptions | withProgressCallback (std::function< bool(int bytesSent, int totalBytes)> progressCallback) const |
A callback function to keep track of the operation's progress. | |
JUCE_NODISCARD InputStreamOptions | withExtraHeaders (const String &extraHeaders) const |
A string that will be appended onto the headers that are used for the request. | |
JUCE_NODISCARD InputStreamOptions | withConnectionTimeoutMs (int connectionTimeoutMs) const |
Specifies a timeout for the request in milliseconds. | |
JUCE_NODISCARD InputStreamOptions | withResponseHeaders (StringPairArray *responseHeaders) const |
If this is non-null, all the (key, value) pairs received as headers in the response will be stored in this array. | |
JUCE_NODISCARD InputStreamOptions | withStatusCode (int *statusCode) const |
If this is non-null, it will get set to the http status code, if one is known, or 0 if a code isn't available. | |
JUCE_NODISCARD InputStreamOptions | withNumRedirectsToFollow (int numRedirectsToFollow) const |
Specifies the number of redirects that will be followed before returning a response. | |
JUCE_NODISCARD InputStreamOptions | withHttpRequestCmd (const String &httpRequestCmd) const |
Specifies which HTTP request command to use. | |
ParameterHandling | getParameterHandling () const noexcept |
std::function< bool(int, int)> | getProgressCallback () const noexcept |
String | getExtraHeaders () const noexcept |
int | getConnectionTimeoutMs () const noexcept |
StringPairArray * | getResponseHeaders () const noexcept |
int * | getStatusCode () const noexcept |
int | getNumRedirectsToFollow () const noexcept |
String | getHttpRequestCmd () const noexcept |
Class used to create a set of options to pass to the createInputStream() method.
You can chain together a series of calls to this class's methods to create a set of whatever options you want to specify, e.g.
|
explicit |
Constructor.
If parameterHandling is ParameterHandling::inPostData, any URL parameters that have been set will be transferred via the request body data. Otherwise the parameters will be added to the URL address.
Referenced by withConnectionTimeoutMs(), withExtraHeaders(), withHttpRequestCmd(), withNumRedirectsToFollow(), withProgressCallback(), withResponseHeaders(), and withStatusCode().
JUCE_NODISCARD InputStreamOptions URL::InputStreamOptions::withProgressCallback | ( | std::function< bool(int bytesSent, int totalBytes)> | progressCallback | ) | const |
A callback function to keep track of the operation's progress.
This can be useful for lengthy POST operations, so that you can provide user feedback.
References InputStreamOptions(), and JUCE_NODISCARD.
JUCE_NODISCARD InputStreamOptions URL::InputStreamOptions::withExtraHeaders | ( | const String & | extraHeaders | ) | const |
A string that will be appended onto the headers that are used for the request.
It must be a valid set of HTML header directives, separated by newlines.
References InputStreamOptions(), and JUCE_NODISCARD.
JUCE_NODISCARD InputStreamOptions URL::InputStreamOptions::withConnectionTimeoutMs | ( | int | connectionTimeoutMs | ) | const |
Specifies a timeout for the request in milliseconds.
If 0, this will use whatever default setting the OS chooses. If a negative number, it will be infinite.
References InputStreamOptions(), and JUCE_NODISCARD.
JUCE_NODISCARD InputStreamOptions URL::InputStreamOptions::withResponseHeaders | ( | StringPairArray * | responseHeaders | ) | const |
If this is non-null, all the (key, value) pairs received as headers in the response will be stored in this array.
References InputStreamOptions(), and JUCE_NODISCARD.
JUCE_NODISCARD InputStreamOptions URL::InputStreamOptions::withStatusCode | ( | int * | statusCode | ) | const |
If this is non-null, it will get set to the http status code, if one is known, or 0 if a code isn't available.
References InputStreamOptions(), and JUCE_NODISCARD.
JUCE_NODISCARD InputStreamOptions URL::InputStreamOptions::withNumRedirectsToFollow | ( | int | numRedirectsToFollow | ) | const |
Specifies the number of redirects that will be followed before returning a response.
N.B. This will be ignored on Android which follows up to 5 redirects.
References InputStreamOptions(), and JUCE_NODISCARD.
JUCE_NODISCARD InputStreamOptions URL::InputStreamOptions::withHttpRequestCmd | ( | const String & | httpRequestCmd | ) | const |
Specifies which HTTP request command to use.
If this is not set, then the command will be POST if parameterHandling is set to ParameterHandling::inPostData or if any POST data has been specified via withPOSTData(), withFileToUpload(), or withDataToUpload(). Otherwise it will be GET.
References InputStreamOptions(), and JUCE_NODISCARD.
|
noexcept |
|
noexcept |
|
noexcept |
|
noexcept |
|
noexcept |
|
noexcept |
|
noexcept |
|
noexcept |