Qore FileLocationHandler Module Reference 2.3
Loading...
Searching...
No Matches
FileLocationHandlerHttp.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
4/* FileLocationHandlerHttp Copyright 2021 - 2024 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
26namespace FileLocationHandler {
29
30public:
32
35
36
38
46protected:
47 string getTextFileImpl(string scheme, string location, *hash<auto> opts);
48public:
49
50
52
60protected:
61 binary getBinaryFileImpl(string scheme, string location, *hash<auto> opts);
62public:
63
64
66
72protected:
73 Qore::AbstractPollOperation getIoPollerForLocationImpl(string scheme, string location, *hash<auto> opts);
74public:
75
76
78
86protected:
87 Qore::StreamReader getStreamReaderImpl(string scheme, string location, *hash<auto> opts);
88public:
89
90
92
100protected:
101 Qore::InputStream getBinaryStreamImpl(string scheme, string location, *hash<auto> opts);
102public:
103
104
106
113protected:
114 writeFileImpl(string scheme, string location, data contents, *hash<auto> opts);
115public:
116
117
119
132protected:
133 OutputStreamWrapper getOutputStreamImpl(string scheme, string location, *hash<auto> opts);
134public:
135
136
138
140protected:
141 hash<string, hash<FileHandlerOptionInfo>> getReadOptionsImpl();
142public:
143
144
146
148protected:
149 hash<string, hash<FileHandlerOptionInfo>> getWriteOptionsImpl();
150public:
151
152
154
157protected:
158 HTTPClient getHttpClient(string scheme, string location, *hash<auto> opts, reference<string> path, bool do_connect = True);
159public:
160
161};
162};
The abstract file location handler class.
Definition FileLocationHandler.qc.dox.h:53
The class for handling http(s):// locations.
Definition FileLocationHandlerHttp.qc.dox.h:28
binary getBinaryFileImpl(string scheme, string location, *hash< auto > opts)
Retrieves a binary file from the given location.
hash< string, hash< FileHandlerOptionInfo > > getWriteOptionsImpl()
Gets supported write options.
Qore::StreamReader getStreamReaderImpl(string scheme, string location, *hash< auto > opts)
Returns a stream reader for the file's data at the given location.
writeFileImpl(string scheme, string location, data contents, *hash< auto > opts)
Writes data to a file at 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.
string getTextFileImpl(string scheme, string location, *hash< auto > opts)
Retrieves a text 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.
const HttpClientLocationOpts
Valid HTTP location options.
Definition FileLocationHandlerHttp.qc.dox.h:34
hash< string, hash< FileHandlerOptionInfo > > getReadOptionsImpl()
Gets supported read options.
Qore::InputStream getBinaryStreamImpl(string scheme, string location, *hash< auto > opts)
Retrieves 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.
The abstract file location handler class.
Definition OutputStramWrapper.qc.dox.h:28
Contains all public definitions in the FileLocationHandler module.
Definition FileLocationHandler.qc.dox.h:26