Qore ConnectionProvider Module Reference 1.11
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 - 2023 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
27namespace ConnectionProvider {
29
34
35public:
38 "cls": Class::forName("FtpConnection"),
39 };
40
42
52 constructor(string name, string description, string url, hash<auto> attributes = {}, hash<auto> options = {})
53 ;
54
55
57 string getType();
58
59
61
65 *hash<auto> getRuntimeOptions();
66
67
69
74
75
77
82
83
85protected:
87public:
88
89
91
94protected:
95 FtpClient getImpl(bool connect = True, *hash<auto> rtopts);
96public:
97
98
100protected:
101 hash<ConnectionSchemeInfo> getConnectionSchemeInfoImpl();
102public:
103
104};
105}; // ConnectionProvider namespace
string url
connection URL (potentially with password info)
Definition: AbstractConnection.qc.dox.h:44
string name
connection name
Definition: AbstractConnection.qc.dox.h:38
abstract base class for connections
Definition: AbstractConnectionWithInfo.qc.dox.h:32
class for FTP connections; returns Qore::FtpClient objects
Definition: FtpConnection.qc.dox.h:33
setChildCapabilities()
Sets child data provider capabilities.
bool hasDataProvider()
returns True, as the connection returns a data provider with the getDataProvider() method
*hash< auto > getRuntimeOptions()
returns runtime options
FtpClient getImpl(bool connect=True, *hash< auto > rtopts)
returns an Qore::FtpClient object
string getType()
returns "ftp"
const ConnectionScheme
Connection entry info.
Definition: FtpConnection.qc.dox.h:37
DataProvider::AbstractDataProvider getDataProvider()
returns an FtpClientDataProvider object for this connection
constructor(string name, string description, string url, hash< auto > attributes={}, hash< auto > options={})
creates the FtpConnection object
hash< ConnectionSchemeInfo > getConnectionSchemeInfoImpl()
Returns the ConnectionSchemeInfo hash for this object.
The ConnectionProvider namespace.
Definition: AbstractConnection.qc.dox.h:28
Connection provider information.
Definition: ConnectionSchemeCache.qc.dox.h:62