Qore Ssh2Connections Module Reference 1.4
Ssh2Connections.qm.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
4/* Ssh2Connections.qm Copyright 2013 - 2021 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// minimum required Qore version
26
27// require type definitions everywhere
28
29// enable all warnings
30
31
32
33
34}
35
82namespace Ssh2Connections {
84
87class AbstractSsh2Connection : public ConnectionProvider::AbstractConnectionWithInfo {
88
89public:
91
99 constructor(string name, string description, string url, hash<auto> attributes = {}, hash<auto> options = {})
100 ;
101
102};
103
105
109
110public:
112 const ConnectionScheme = ...;
113
114
116
124 constructor(string name, string description, string url, hash<auto> attributes = {}, hash<auto> options = {})
125 ;
126
127
129 string getType();
130
131
133
138protected:
139 Qore::SSH2::SSH2Client getImpl(bool connect = True, *hash<auto> rtopts);
140public:
141
142
144protected:
145 hash<ConnectionSchemeInfo> getConnectionSchemeInfoImpl();
146public:
147
148};
149
151
159
160public:
162 const ConnectionScheme = ...;
163
164
166
174 constructor(string name, string description, string url, hash<auto> attributes = {}, hash<auto> options = {})
175 ;
176
177
179 string getType();
180
181
183
187 *hash<auto> getRuntimeOptions();
188
189
191
198protected:
199 Qore::SSH2::SFTPClient getImpl(bool connect = True, *hash<auto> rtopts);
200public:
201
202
203protected:
204 *string getRuntimePath(*hash<auto> rtopts);
205public:
206
207
209protected:
210 hash<ConnectionSchemeInfo> getConnectionSchemeInfoImpl();
211public:
212
213};
214};
abstract base class for ssh module connections
Definition: Ssh2Connections.qm.dox.h:87
constructor(string name, string description, string url, hash< auto > attributes={}, hash< auto > options={})
creates the AbstractSsh2Connection object
class for SFTP connections; returns an object of class Qore::SSH2::SFTPClient for acquiring files fro...
Definition: Ssh2Connections.qm.dox.h:158
string getType()
returns "sftp"
*hash< auto > getRuntimeOptions()
returns runtime options
constructor(string name, string description, string url, hash< auto > attributes={}, hash< auto > options={})
creates the SftpConnection object
Qore::SSH2::SFTPClient getImpl(bool connect=True, *hash< auto > rtopts)
returns a Qore::SSH2::SFTPClient object
hash< ConnectionSchemeInfo > getConnectionSchemeInfoImpl()
Returns the ConnectionSchemeInfo hash for this object.
const ConnectionScheme
Connection entry info.
Definition: Ssh2Connections.qm.dox.h:162
class for SSH2 client session connections; returns an object of class Qore::SSH2::SSH2Client
Definition: Ssh2Connections.qm.dox.h:108
hash< ConnectionSchemeInfo > getConnectionSchemeInfoImpl()
Returns the ConnectionSchemeInfo hash for this object.
constructor(string name, string description, string url, hash< auto > attributes={}, hash< auto > options={})
creates the Ssh2ClientConnection object
const ConnectionScheme
Connection entry info.
Definition: Ssh2Connections.qm.dox.h:112
Qore::SSH2::SSH2Client getImpl(bool connect=True, *hash< auto > rtopts)
returns a Qore::SSH2::SSH2Client object
the Ssh2Connections namespace contains all the definitions in the Ssh2Connections module
Definition: Ssh2Connections.qm.dox.h:82