Class used to create a set of options to pass to the createInputStream() method.
More...
#include <juce_URL.h>
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.
if (
auto inputStream =
URL (
"http://www.xyz.com/foobar")
{
...
}
◆ InputStreamOptions()
juce::URL::InputStreamOptions::InputStreamOptions |
( |
ParameterHandling |
parameterHandling | ) |
|
|
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.
◆ getConnectionTimeoutMs()
int juce::URL::InputStreamOptions::getConnectionTimeoutMs |
( |
| ) |
const |
|
inlinenoexcept |
◆ getExtraHeaders()
String juce::URL::InputStreamOptions::getExtraHeaders |
( |
| ) |
const |
|
inlinenoexcept |
◆ getHttpRequestCmd()
String juce::URL::InputStreamOptions::getHttpRequestCmd |
( |
| ) |
const |
|
inlinenoexcept |
◆ getNumRedirectsToFollow()
int juce::URL::InputStreamOptions::getNumRedirectsToFollow |
( |
| ) |
const |
|
inlinenoexcept |
◆ getParameterHandling()
◆ getProgressCallback()
std::function<bool (int, int)> juce::URL::InputStreamOptions::getProgressCallback |
( |
| ) |
const |
|
inlinenoexcept |
◆ getResponseHeaders()
StringPairArray* juce::URL::InputStreamOptions::getResponseHeaders |
( |
| ) |
const |
|
inlinenoexcept |
◆ getStatusCode()
int* juce::URL::InputStreamOptions::getStatusCode |
( |
| ) |
const |
|
inlinenoexcept |
◆ withConnectionTimeoutMs()
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.
◆ withExtraHeaders()
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.
◆ withHttpRequestCmd()
◆ withNumRedirectsToFollow()
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.
◆ withProgressCallback()
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.
◆ withResponseHeaders()
If this is non-null, all the (key, value) pairs received as headers in the response will be stored in this array.
◆ withStatusCode()
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.
◆ connectionTimeOutMs
int juce::URL::InputStreamOptions::connectionTimeOutMs = 0 |
|
private |
◆ extraHeaders
String juce::URL::InputStreamOptions::extraHeaders |
|
private |
◆ httpRequestCmd
String juce::URL::InputStreamOptions::httpRequestCmd |
|
private |
◆ numRedirectsToFollow
int juce::URL::InputStreamOptions::numRedirectsToFollow = 5 |
|
private |
◆ parameterHandling
◆ progressCallback
std::function<bool (int, int)> juce::URL::InputStreamOptions::progressCallback = nullptr |
|
private |
◆ responseHeaders
◆ statusCode
int* juce::URL::InputStreamOptions::statusCode = nullptr |
|
private |
The documentation for this class was generated from the following file: