| Qore FileLocationHandler Module Reference 2.0

FileLocationHandlerHttp.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
3
4 /* FileLocationHandlerHttp Copyright 2021 - 2022 Qore Technologies, s.r.o.
5
6 Permission is hereby granted, free of charge, to any person obtaining a
7 copy of this software and associated documentation files (the "Software"),
8 to deal in the Software without restriction, including without limitation
9 the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 and/or sell copies of the Software, and to permit persons to whom the
11 Software is furnished to do so, subject to the following conditions:
12
13 The above copyright notice and this permission notice shall be included in
14 all copies or substantial portions of the Software.
15
16 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 DEALINGS IN THE SOFTWARE.
23 */
24
26 namespace FileLocationHandler {
28 class FileLocationHandlerHttp : public AbstractFileLocationHandler {
29
30 public:
32
34 const HttpClientLocationOpts = ...;
35
36
38
46 protected:
47 string getTextFileImpl(string scheme, string location, *hash<auto> opts);
48 public:
49
50
52
60 protected:
61 binary getBinaryFileImpl(string scheme, string location, *hash<auto> opts);
62 public:
63
64
66
72 protected:
73 Qore::StreamReader getStreamReaderImpl(string scheme, string location, *hash<auto> opts);
74 public:
75
76
78
84 protected:
85 Qore::InputStream getBinaryStreamImpl(string scheme, string location, *hash<auto> opts);
86 public:
87
88
90
95 protected:
96 writeFileImpl(string scheme, string location, data contents, *hash<auto> opts);
97 public:
98
99
101
113 protected:
114 OutputStreamWrapper getOutputStreamImpl(string scheme, string location, *hash<auto> opts);
115 public:
116
117
119
121 protected:
122 hash<string, hash<FileHandlerOptionInfo>> getReadOptionsImpl();
123 public:
124
125
127
129 protected:
130 hash<string, hash<FileHandlerOptionInfo>> getWriteOptionsImpl();
131 public:
132
133
135 protected:
136 HTTPClient getHttpClient(string scheme, string location, *hash<auto> opts, reference<string> path);
137 public:
138
139 };
140 };
FileLocationHandler::AbstractFileLocationHandler
The abstract file location handler class.
Definition: FileLocationHandler.qc.dox.h:43
FileLocationHandler::FileLocationHandlerHttp
The class for handling file locations.
Definition: FileLocationHandlerHttp.qc.dox.h:28
FileLocationHandler::FileLocationHandlerHttp::getBinaryFileImpl
binary getBinaryFileImpl(string scheme, string location, *hash< auto > opts)
Retrieves a binary file from the given location.
FileLocationHandler::FileLocationHandlerHttp::getStreamReaderImpl
Qore::StreamReader getStreamReaderImpl(string scheme, string location, *hash< auto > opts)
Returns a stream reader for the file's data at the given location.
FileLocationHandler::FileLocationHandlerHttp::writeFileImpl
writeFileImpl(string scheme, string location, data contents, *hash< auto > opts)
Writes data to a file at the given location.
FileLocationHandler::FileLocationHandlerHttp::getHttpClient
HTTPClient getHttpClient(string scheme, string location, *hash< auto > opts, reference< string > path)
Returns an HTTP client for the given location.
FileLocationHandler::FileLocationHandlerHttp::getTextFileImpl
string getTextFileImpl(string scheme, string location, *hash< auto > opts)
Retrieves a text file from the given location.
FileLocationHandler::FileLocationHandlerHttp::HttpClientLocationOpts
const HttpClientLocationOpts
Valid HTTP location options.
Definition: FileLocationHandlerHttp.qc.dox.h:34
FileLocationHandler::FileLocationHandlerHttp::getWriteOptionsImpl
hash< string, hash< FileHandlerOptionInfo > > getWriteOptionsImpl()
Gets supported write options.
FileLocationHandler::FileLocationHandlerHttp::getBinaryStreamImpl
Qore::InputStream getBinaryStreamImpl(string scheme, string location, *hash< auto > opts)
Retrieves a binary file from the given location.
FileLocationHandler::FileLocationHandlerHttp::getReadOptionsImpl
hash< string, hash< FileHandlerOptionInfo > > getReadOptionsImpl()
Gets supported read options.
FileLocationHandler::FileLocationHandlerHttp::getOutputStreamImpl
OutputStreamWrapper getOutputStreamImpl(string scheme, string location, *hash< auto > opts)
Returns an output stream for writing data to the given location.
FileLocationHandler::OutputStreamWrapper
The abstract file location handler class.
Definition: OutputStramWrapper.qc.dox.h:28
Qore::InputStream
Qore::StreamReader
binary
binary binary()
FileLocationHandler
Contains all public definitions in the FileLocationHandler module.
Definition: FileLocationHandler.qc.dox.h:26