| Qore ConnectionProvider Module Reference 2.0.1

Loading...
Searching...
No Matches
FtpConnection.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
2// Qore FtpConnection class definition
3
4/* FtpConnection.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
25
27 namespace ConnectionProvider {
29
33 class FtpConnection : public AbstractConnectionWithInfo {
34
35 public:
37 const ConnectionScheme = ...;
38
39
41 const DataProviderSubtypeMap = ...;
42
43
44 protected:
46 static hash<string, *hash<string, hash<DataProviderOptionInfo>>> subtype_info;
47
49 static Mutex subtype_lck();
50
51 public:
52
54
64 constructor(string name, string description, string url, hash<auto> attributes = {}, hash<auto> options = {}, *Logger logger) ;
65
66
68
85 constructor(hash<auto> config, *hash<auto> attr) ;
86
87
89 string getType();
90
91
93
97 *hash<auto> getRuntimeOptions();
98
99
101
107 DataProvider::AbstractDataProvider getDataProvider(*hash<auto> constructor_options);
108
109
111
115 bool hasDataProvider();
116
117
119
134 protected:
135 AbstractDataProvider getDataProviderImpl(string subtype, *hash<auto> constructor_options);
136 public:
137
138
140 protected:
141 setChildCapabilities();
142 public:
143
144
146
148 protected:
149 checkSubtypeInfo();
150 public:
151
152
154
158 protected:
159 *hash<string, *hash<string, hash<DataProviderOptionInfo>>> getDataProviderSubtypesImpl();
160 public:
161
162
164 protected:
165 loadSubtypeInfo();
166 public:
167
168
170
174 protected:
175 FtpClient getImpl(bool connect = True, *hash<auto> rtopts);
176 public:
177
178
180 protected:
181 hash<ConnectionSchemeInfo> getConnectionSchemeInfoImpl();
182 public:
183
184};
185}; // 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::FtpConnection
class for FTP connections; returns Qore::FtpClient objects
Definition FtpConnection.qc.dox.h:33
ConnectionProvider::FtpConnection::getDataProvider
DataProvider::AbstractDataProvider getDataProvider(*hash< auto > constructor_options)
returns an FtpClientDataProvider object for this connection
ConnectionProvider::FtpConnection::setChildCapabilities
setChildCapabilities()
Sets child data provider capabilities.
ConnectionProvider::FtpConnection::loadSubtypeInfo
loadSubtypeInfo()
Loads subtype info from external modules.
ConnectionProvider::FtpConnection::hasDataProvider
bool hasDataProvider()
returns True, as the connection returns a data provider with the getDataProvider() method
ConnectionProvider::FtpConnection::getRuntimeOptions
*hash< auto > getRuntimeOptions()
returns runtime options
ConnectionProvider::FtpConnection::DataProviderSubtypeMap
const DataProviderSubtypeMap
Data provider subtypes supported.
Definition FtpConnection.qc.dox.h:41
ConnectionProvider::FtpConnection::getImpl
FtpClient getImpl(bool connect=True, *hash< auto > rtopts)
Returns an FtpClient object.
ConnectionProvider::FtpConnection::getDataProviderSubtypesImpl
*hash< string, *hash< string, hash< DataProviderOptionInfo > > > getDataProviderSubtypesImpl()
Returns a hash of supported data provider subtypes.
ConnectionProvider::FtpConnection::getType
string getType()
returns "ftp"
ConnectionProvider::FtpConnection::ConnectionScheme
const ConnectionScheme
Connection entry info.
Definition FtpConnection.qc.dox.h:37
ConnectionProvider::FtpConnection::subtype_lck
static Mutex subtype_lck()
Data provider subtype lock.
ConnectionProvider::FtpConnection::checkSubtypeInfo
checkSubtypeInfo()
Verifies that subtype info has been loaded from external modules.
ConnectionProvider::FtpConnection::getConnectionSchemeInfoImpl
hash< ConnectionSchemeInfo > getConnectionSchemeInfoImpl()
Returns the ConnectionSchemeInfo hash for this object.
ConnectionProvider::FtpConnection::getDataProviderImpl
AbstractDataProvider getDataProviderImpl(string subtype, *hash< auto > constructor_options)
returns a data provider object for the connection and subtype passed as an argument
ConnectionProvider::FtpConnection::subtype_info
static hash< string, *hash< string, hash< DataProviderOptionInfo > > > subtype_info
Data provider subtype info.
Definition FtpConnection.qc.dox.h:46
ConnectionProvider::FtpConnection::constructor
constructor(string name, string description, string url, hash< auto > attributes={}, hash< auto > options={}, *Logger logger)
creates the FtpConnection object
ConnectionProvider::FtpConnection::constructor
constructor(hash< auto > config, *hash< auto > attr)
creates the FtpConnection object
ConnectionProvider
The ConnectionProvider namespace.
Definition AbstractConnection.qc.dox.h:28