| Qore ConnectionProvider Module Reference 2.0.1

Loading...
Searching...
No Matches
FilesystemConnection.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
2// Qore FilesystemConnection class definition
3
4/* FilesystemConnection.qc Copyright 2016 - 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
26 namespace ConnectionProvider {
28
36 class FilesystemConnection : public AbstractConnectionWithInfo {
37
38 public:
40 const ConnectionScheme = ...;
41
42
44 const DataProviderSubtypeMap = ...;
45
46
47 protected:
49 static hash<string, *hash<string, hash<DataProviderOptionInfo>>> subtype_info;
50
52 static Mutex subtype_lck();
53
54 public:
55
57
67 constructor(string name, string description, string url, hash<auto> attributes = {}, hash<auto> options = {}, *Logger logger)
68 ;
69
70
72
89 constructor(hash<auto> config, *hash<auto> attr) ;
90
91
93 string getType();
94
95
97
99 bool hasDataProvider();
100
101
103
107 AbstractDataProvider getDataProvider(*hash<auto> constructor_options);
108
109
111 protected:
112 setupFsOpts();
113 public:
114
115
117
119 protected:
120 checkSubtypeInfo();
121 public:
122
123
125
129 protected:
130 *hash<string, *hash<string, hash<DataProviderOptionInfo>>> getDataProviderSubtypesImpl();
131 public:
132
133
135 protected:
136 loadSubtypeInfo();
137 public:
138
139
141
149 protected:
150 AbstractDataProvider getDataProviderImpl(string subtype, *hash<auto> constructor_options);
151 public:
152
153
155
157 protected:
158 *hash<string, hash<DataProviderOptionInfo>> getDataProviderConstructorOptionsImpl();
159 public:
160
161
163
169 protected:
170 Dir getImpl(bool connect = True, *hash rtopts);
171 public:
172
173
175 protected:
176 hash<ConnectionSchemeInfo> getConnectionSchemeInfoImpl();
177 public:
178
179};
180}; // ConnectionProvider namespace
ConnectionProvider::AbstractConnection::url
string url
Connection URL (potentially with password info)
Definition AbstractConnection.qc.dox.h:85
ConnectionProvider::AbstractConnection::name
string name
Connection name.
Definition AbstractConnection.qc.dox.h:73
ConnectionProvider::AbstractConnectionWithInfo
abstract base class for connections
Definition AbstractConnectionWithInfo.qc.dox.h:32
ConnectionProvider::FilesystemConnection
class for filesystem connections; returns an object of type Qore::Dir
Definition FilesystemConnection.qc.dox.h:36
ConnectionProvider::FilesystemConnection::subtype_info
static hash< string, *hash< string, hash< DataProviderOptionInfo > > > subtype_info
Data provider subtype info.
Definition FilesystemConnection.qc.dox.h:49
ConnectionProvider::FilesystemConnection::hasDataProvider
bool hasDataProvider()
returns True
ConnectionProvider::FilesystemConnection::checkSubtypeInfo
checkSubtypeInfo()
Verifies that subtype info has been loaded from external modules.
ConnectionProvider::FilesystemConnection::getDataProviderImpl
AbstractDataProvider getDataProviderImpl(string subtype, *hash< auto > constructor_options)
returns a data provider object for connection subtype passed as an argument
ConnectionProvider::FilesystemConnection::getDataProviderConstructorOptionsImpl
*hash< string, hash< DataProviderOptionInfo > > getDataProviderConstructorOptionsImpl()
Returns a hash of data provider constructor option info, if applicable.
ConnectionProvider::FilesystemConnection::getDataProviderSubtypesImpl
*hash< string, *hash< string, hash< DataProviderOptionInfo > > > getDataProviderSubtypesImpl()
Returns a hash of supported data provider subtypes.
ConnectionProvider::FilesystemConnection::setupFsOpts
setupFsOpts()
Common constructor initialization.
ConnectionProvider::FilesystemConnection::getDataProvider
AbstractDataProvider getDataProvider(*hash< auto > constructor_options)
Returns a data provider object for this connection.
ConnectionProvider::FilesystemConnection::subtype_lck
static Mutex subtype_lck()
Data provider subtype lock.
ConnectionProvider::FilesystemConnection::ConnectionScheme
const ConnectionScheme
Connection entry info.
Definition FilesystemConnection.qc.dox.h:40
ConnectionProvider::FilesystemConnection::constructor
constructor(hash< auto > config, *hash< auto > attr)
creates the FilesystemConnection object
ConnectionProvider::FilesystemConnection::constructor
constructor(string name, string description, string url, hash< auto > attributes={}, hash< auto > options={}, *Logger logger)
creates the FilesystemConnection object
ConnectionProvider::FilesystemConnection::getType
string getType()
returns "file"
ConnectionProvider::FilesystemConnection::getConnectionSchemeInfoImpl
hash< ConnectionSchemeInfo > getConnectionSchemeInfoImpl()
Returns the ConnectionSchemeInfo hash for this object.
ConnectionProvider::FilesystemConnection::getImpl
Dir getImpl(bool connect=True, *hash rtopts)
returns a Qore::Dir object
ConnectionProvider::FilesystemConnection::DataProviderSubtypeMap
const DataProviderSubtypeMap
Data provider subtypes supported.
Definition FilesystemConnection.qc.dox.h:44
ConnectionProvider::FilesystemConnection::loadSubtypeInfo
loadSubtypeInfo()
Loads subtype info from external modules.
ConnectionProvider
The ConnectionProvider namespace.
Definition AbstractConnection.qc.dox.h:28