Qore FileLocationHandler Module Reference  1.0
FileLocationHandler::FileLocationHandlerHttp Class Reference

The class for handling file locations. More...

Inheritance diagram for FileLocationHandler::FileLocationHandlerHttp:

Static Public Member Methods

static data handler (string scheme, bool text, string location)
 Returns the file data from the given file location. More...
 
- Static Public Member Methods inherited from FileLocationHandler::FileLocationHandler
static binary getBinaryFileFromLocation (string location)
 Returns binary data for the given file location. More...
 
static data getFileFromLocation (bool text, string location)
 Returns the file data from the given location. More...
 
static list< stringgetSupportedSchemes ()
 Retuns a list of supported schemes. More...
 
static string getTextFileFromLocation (string location)
 Returns string data for the given file location. More...
 
static bool isSchemeSupported (string scheme)
 Returns True if the scheme is supported. More...
 
static registerHandler (string scheme, code handler)
 Register a new location handler. More...
 

Public Attributes

const HttpClientLocationOpts = ...
 Valid HTTP location options. More...
 

Additional Inherited Members

- Static Private Member Methods inherited from FileLocationHandler::FileLocationHandler
static string forceEncoding (string str, *string encoding)
 Returns a string tagged with the given encoding, if any.
 
static *hash< auto > getOptions (reference< string > location)
 Returns a hash option options from the location string.
 
static data getTextOrBin (data d, bool text, *string encoding)
 Helper method to eturn data in the expected format. More...
 
static Mutex handler_lock ()
 The location handler lock to ensure atomic operations.
 
- Static Private Attributes inherited from FileLocationHandler::FileLocationHandler
static hash< string, code > cache
 The location handler cache; scheme -> handler;. More...
 

Detailed Description

The class for handling file locations.

Member Function Documentation

◆ handler()

static data FileLocationHandler::FileLocationHandlerHttp::handler ( string  scheme,
bool  text,
string  location 
)
static

Returns the file data from the given file location.

Parameters
schemethe original scheme string in the location
texta flag if the data should be returned as text or not
locationthe location string
Exceptions
LOCATION-ERRORinvalid file location options

Member Data Documentation

◆ HttpClientLocationOpts

const FileLocationHandler::FileLocationHandlerHttp::HttpClientLocationOpts = ...

Valid HTTP location options.

See also
HTTPClient::constructor() for supported options