Qore ConnectionProvider Module Reference  1.5
FtpConnection.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
2 // Qore FtpConnection class definition
3 
4 /* FtpConnection.qc Copyright 2016 - 2020 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 
34 
35 public:
37  const ConnectionScheme = ...;
38 
39 
41 
51  constructor(string name, string description, string url, hash<auto> attributes = {}, hash<auto> options = {})
52  ;
53 
54 
56  string getType();
57 
58 
60 
64  *hash<auto> getRuntimeOptions();
65 
66 
68 
71 protected:
72  FtpClient getImpl(bool connect = True, *hash rtopts);
73 public:
74 
75 
77 protected:
78  hash<ConnectionSchemeInfo> getConnectionSchemeInfoImpl();
79 public:
80 
81 };
82 }; // ConnectionProvider namespace
hash< ConnectionSchemeInfo > getConnectionSchemeInfoImpl()
Returns the ConnectionSchemeInfo hash for this object.
abstract base class for connections
Definition: AbstractConnectionWithInfo.qc.dox.h:30
const True
string name
connection name
Definition: AbstractConnection.qc.dox.h:36
*hash< auto > getRuntimeOptions()
returns runtime options
const ConnectionScheme
Connection entry info.
Definition: FtpConnection.qc.dox.h:37
FtpClient getImpl(bool connect=True, *hash rtopts)
returns an Qore::FtpClient object
hash< auto > hash(object obj)
class for FTP connections; returns Qore::FtpClient objects
Definition: FtpConnection.qc.dox.h:33
constructor(string name, string description, string url, hash< auto > attributes={}, hash< auto > options={})
creates the FtpConnection object
string url
connection URL (potentially with password info)
Definition: AbstractConnection.qc.dox.h:42
the ConnectionProvider namespace. All classes used in the ConnectionProvider module should be inside ...
Definition: AbstractConnection.qc.dox.h:26
string getType()
returns "ftp"