Qore Ssh2Connections Module Reference  1.0
Ssh2Connections.qm.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
3 
4 /* Ssh2Connections.qm Copyright 2013 - 2016 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 //%requires Util >= 1.0
33 
34 
35 
63 namespace Ssh2Connections {
66 
69 class AbstractSsh2Connection : public ConnectionProvider::AbstractConnection {
70 
71 public:
73 
80  constructor(string name, string desc, string url, bool monitor, *hash opts, hash urlh) ;
81 
82 
84 
86  hash getOptions();
87 
88  };
89 
91 
95 
96 public:
98 
105  constructor(string name, string desc, string url, bool monitor, *hash opts, hash urlh) ;
106 
107 
109  string getType();
110 
111 
113 
119 private:
120  Qore::SSH2::SSH2Client getImpl(bool connect = True, *hash rtopts);
121 public:
122 
123 
125  static SftpConnection make(string name, string desc, string url, bool monitor, *hash opts, hash urlh);
126  };
127 
129 
137 
138 public:
140 
147  constructor(string name, string desc, string url, bool monitor, *hash opts, hash urlh) ;
148 
149 
151  string getType();
152 
153 
155 
159  *hash getRuntimeOptions();
160 
161 
163 
171 private:
172  Qore::SSH2::SFTPClient getImpl(bool connect = True, *hash rtopts);
173 public:
174 
175 
176 
177 private:
178  *string getRuntimePath(*hash rtopts);
179 public:
180 
181 
183  static SftpConnection make(string name, string desc, string url, bool monitor, *hash opts, hash urlh);
184  };
185 };
class for SSH2 client session connections; returns an object of class Qore::SSH2::SSH2Client ...
Definition: Ssh2Connections.qm.dox.h:94
the Ssh2Connections namespace contains all the definitions in the Ssh2Connections module ...
Definition: Ssh2Connections.qm.dox.h:64
class for SFTP connections; returns an object of class Qore::SSH2::SFTPClient for acquiring files fro...
Definition: Ssh2Connections.qm.dox.h:136
constructor(string name, string desc, string url, bool monitor, *hash opts, hash urlh)
creates the SftpConnection object
hash getOptions()
returns valid options
abstract base class for ssh module connections
Definition: Ssh2Connections.qm.dox.h:69