Qore FileLocationHandler Module Reference 2.3
Loading...
Searching...
No Matches
FileLocationHandler::FileLocationHandlerHttp Class Reference

The class for handling http(s):// locations. More...

#include <FileLocationHandlerHttp.qc.dox.h>

Inheritance diagram for FileLocationHandler::FileLocationHandlerHttp:
[legend]

Public Attributes

const HttpClientLocationOpts = ...
 Valid HTTP location options.
 

Protected Member Functions

binary getBinaryFileImpl (string scheme, string location, *hash< auto > opts)
 Retrieves a binary file from the given location.
 
Qore::InputStream getBinaryStreamImpl (string scheme, string location, *hash< auto > opts)
 Retrieves a binary file from the given location.
 
HTTPClient getHttpClient (string scheme, string location, *hash< auto > opts, reference< string > path, bool do_connect=True)
 Returns an HTTP client for the given location.
 
Qore::AbstractPollOperation getIoPollerForLocationImpl (string scheme, string location, *hash< auto > opts)
 Retrieves an I/O poller to retrieve a binary file from the given location.
 
OutputStreamWrapper getOutputStreamImpl (string scheme, string location, *hash< auto > opts)
 Returns an output stream for writing data to the given location.
 
hash< string, hash< FileHandlerOptionInfo > > getReadOptionsImpl ()
 Gets supported read options.
 
Qore::StreamReader getStreamReaderImpl (string scheme, string location, *hash< auto > opts)
 Returns a stream reader for the file's data at the given location.
 
string getTextFileImpl (string scheme, string location, *hash< auto > opts)
 Retrieves a text file from the given location.
 
hash< string, hash< FileHandlerOptionInfo > > getWriteOptionsImpl ()
 Gets supported write options.
 
 writeFileImpl (string scheme, string location, data contents, *hash< auto > opts)
 Writes data to a file at the given location.
 
- Protected Member Functions inherited from FileLocationHandler::AbstractFileLocationHandler
abstract binary getBinaryFileImpl (string scheme, string location, *hash< auto > opts)
 Retrieves a binary file from the given location.
 
abstract Qore::InputStream getBinaryStreamImpl (string scheme, string location, *hash< auto > opts)
 Retrieves a binary file from the given location.
 
abstract Qore::AbstractPollOperation getIoPollerForLocationImpl (string scheme, string location, *hash< auto > opts)
 Retrieves an I/O poller to retrieve a binary file from the given location.
 
abstract OutputStreamWrapper getOutputStreamImpl (string scheme, string location, *hash< auto > opts)
 Returns an output stream for writing data to the given location.
 
abstract hash< string, hash< FileHandlerOptionInfo > > getReadOptionsImpl ()
 Gets supported read options.
 
abstract Qore::StreamReader getStreamReaderImpl (string scheme, string location, *hash< auto > opts)
 Returns a string stream for the file's data at the given location.
 
abstract string getTextFileImpl (string scheme, string location, *hash< auto > opts)
 Retrieves a text file from the given location.
 
abstract hash< string, hash< FileHandlerOptionInfo > > getWriteOptionsImpl ()
 Gets supported write options.
 
abstract writeFileImpl (string scheme, string location, data contents, *hash< auto > opts)
 Writes data to a file at the given location.
 

Additional Inherited Members

- Public Member Functions inherited from FileLocationHandler::AbstractFileLocationHandler
binary getBinaryFile (string scheme, string location, *hash< auto > opts)
 Retrieves a binary file from the given location.
 
Qore::InputStream getBinaryStream (string scheme, string location, *hash< auto > opts)
 Retrieves a binary file from the given location.
 
Qore::AbstractPollOperation getIoPollerForLocation (string scheme, string location, *hash< auto > opts)
 Retrieves an I/O poller to retrieve a binary file from the given location.
 
OutputStreamWrapper getOutputStream (string scheme, string location, *hash< auto > opts)
 Returns an output stream for writing data to the given location.
 
hash< string, hash< FileHandlerOptionInfo > > getReadOptions ()
 Gets supported read options.
 
Qore::StreamReader getStreamReader (string scheme, string location, *hash< auto > opts)
 Returns a string stream for the file's data at the given location.
 
string getTextFile (string scheme, string location, *hash< auto > opts)
 Retrieves a text file from the given location.
 
hash< string, hash< FileHandlerOptionInfo > > getWriteOptions ()
 Gets supported write options.
 
 writeFile (string scheme, string location, data contents, *hash< auto > opts)
 Writes data to a file at the given location.
 
- Static Protected Member Functions inherited from FileLocationHandler::AbstractFileLocationHandler
static string forceEncoding (string str, *string encoding)
 Returns a string tagged with the given encoding, if any.
 

Detailed Description

The class for handling http(s):// locations.

Member Function Documentation

◆ getBinaryFileImpl()

binary FileLocationHandler::FileLocationHandlerHttp::getBinaryFileImpl ( string scheme,
string location,
*hash< auto > opts )
protected

Retrieves a binary file from the given location.

Parameters
schemethe scheme being used
locationthe location string without the scheme
optsread options
Returns
the binary data of the file's contents, if it can be retrieved
Note
This method can throw any exception related to making an HTTP call

◆ getBinaryStreamImpl()

Qore::InputStream FileLocationHandler::FileLocationHandlerHttp::getBinaryStreamImpl ( string scheme,
string location,
*hash< auto > opts )
protected

Retrieves a binary file from the given location.

Parameters
schemethe scheme being used
locationthe location string without the scheme
optsread options
Returns
an input stream of the file's contents, if it can be retrieved
Note
This method can throw any exception related to making an HTTP call

◆ getHttpClient()

HTTPClient FileLocationHandler::FileLocationHandlerHttp::getHttpClient ( string scheme,
string location,
*hash< auto > opts,
reference< string > path,
bool do_connect = True )
protected

Returns an HTTP client for the given location.

Note
This method can throw any exception related to making an HTTP connection

◆ getIoPollerForLocationImpl()

Qore::AbstractPollOperation FileLocationHandler::FileLocationHandlerHttp::getIoPollerForLocationImpl ( string scheme,
string location,
*hash< auto > opts )
protected

Retrieves an I/O poller to retrieve a binary file from the given location.

Parameters
schemethe scheme being used
locationthe location string without the scheme
optsread options
Returns
an I/O poller to retrieve the file's data

◆ getOutputStreamImpl()

OutputStreamWrapper FileLocationHandler::FileLocationHandlerHttp::getOutputStreamImpl ( string scheme,
string location,
*hash< auto > opts )
protected

Returns an output stream for writing data to the given location.

Parameters
schemethe scheme being used
locationthe location string without the scheme
optswrite options
Returns
an output stream for writing to the file
Note
  • OutputStream::close() must be called to close the stream after writing terminates in order to avoid a deadlock
  • The data written to the OutputStreamWrapper object is written in the background; to ensure that the data has been written to the target, call OutputStreamWrapper::waitForIo()
  • This method can throw any exception related to making an HTTP call

◆ getReadOptionsImpl()

hash< string, hash< FileHandlerOptionInfo > > FileLocationHandler::FileLocationHandlerHttp::getReadOptionsImpl ( )
protected

Gets supported read options.

Returns
supported read options

◆ getStreamReaderImpl()

Qore::StreamReader FileLocationHandler::FileLocationHandlerHttp::getStreamReaderImpl ( string scheme,
string location,
*hash< auto > opts )
protected

Returns a stream reader for the file's data at the given location.

Parameters
schemethe scheme being used
locationthe location string without the scheme
optsread options
Returns
a stream reader for the file's contents, if it can be retrieved
Note
This method can throw any exception related to making an HTTP call

◆ getTextFileImpl()

string FileLocationHandler::FileLocationHandlerHttp::getTextFileImpl ( string scheme,
string location,
*hash< auto > opts )
protected

Retrieves a text file from the given location.

Parameters
schemethe scheme being used
locationthe location string without the scheme
optsread options
Returns
the string of the file's contents, if it can be retrieved
Note
This method can throw any exception related to making an HTTP call

◆ getWriteOptionsImpl()

hash< string, hash< FileHandlerOptionInfo > > FileLocationHandler::FileLocationHandlerHttp::getWriteOptionsImpl ( )
protected

Gets supported write options.

Returns
supported write options

◆ writeFileImpl()

FileLocationHandler::FileLocationHandlerHttp::writeFileImpl ( string scheme,
string location,
data contents,
*hash< auto > opts )
protected

Writes data to a file at the given location.

Parameters
schemethe scheme being used
locationthe location string without the scheme
contentsthe file's contents
optswrite options
Note
This method can throw any exception related to making an HTTP call

Member Data Documentation

◆ HttpClientLocationOpts

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

Valid HTTP location options.

See also
HTTPClient::constructor() for supported options