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")
 
{
    ...
}
Represents a URL and has a bunch of useful functions to manipulate it.
Definition juce_URL.h:39
std::unique_ptr< InputStream > createInputStream(const InputStreamOptions &options) const
Attempts to open a stream that can read from this URL.
◆ InputStreamOptions()
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. 
 
 
◆ withProgressCallback()
      
        
          | 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. 
 
 
◆ 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. 
 
 
◆ withConnectionTimeoutMs()
      
        
          | 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. 
 
 
◆ 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. 
 
 
◆ withNumRedirectsToFollow()
      
        
          | 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. 
 
 
◆ withHttpRequestCmd()
◆ getParameterHandling()
◆ getProgressCallback()
  
  | 
        
          | std::function< bool(int, int)> URL::InputStreamOptions::getProgressCallback | ( |  | ) | const |  | noexcept | 
 
 
◆ getExtraHeaders()
  
  | 
        
          | String URL::InputStreamOptions::getExtraHeaders | ( |  | ) | const |  | noexcept | 
 
 
◆ getConnectionTimeoutMs()
  
  | 
        
          | int URL::InputStreamOptions::getConnectionTimeoutMs | ( |  | ) | const |  | noexcept | 
 
 
◆ getResponseHeaders()
◆ getStatusCode()
  
  | 
        
          | int * URL::InputStreamOptions::getStatusCode | ( |  | ) | const |  | noexcept | 
 
 
◆ getNumRedirectsToFollow()
  
  | 
        
          | int URL::InputStreamOptions::getNumRedirectsToFollow | ( |  | ) | const |  | noexcept | 
 
 
◆ getHttpRequestCmd()
  
  | 
        
          | String URL::InputStreamOptions::getHttpRequestCmd | ( |  | ) | const |  | noexcept | 
 
 
The documentation for this class was generated from the following file: