Loading...
Searching...
No Matches
FtpConnection.qc.dox.h
// -*- mode: c++; indent-tabs-mode: nil -*-
// Qore FtpConnection class definition
/* FtpConnection.qc Copyright 2016 - 2023 Qore Technologies, s.r.o.
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
*/
namespace ConnectionProvider {
class FtpConnection : public AbstractConnectionWithInfo {
public:
const ConnectionScheme = <ConnectionSchemeInfo>{
"cls": Class::forName("FtpConnection"),
};
constructor(string name, string description, string url, hash<auto> attributes = {}, hash<auto> options = {})
;
string getType();
*hash<auto> getRuntimeOptions();
DataProvider::AbstractDataProvider getDataProvider();
bool hasDataProvider();
protected:
setChildCapabilities();
public:
protected:
FtpClient getImpl(bool connect = True, *hash<auto> rtopts);
public:
protected:
hash<ConnectionSchemeInfo> getConnectionSchemeInfoImpl();
public:
};
}; // ConnectionProvider namespace
ConnectionProvider::AbstractConnection::url
string url
connection URL (potentially with password info)
Definition: AbstractConnection.qc.dox.h:44
ConnectionProvider::AbstractConnection::name
string name
connection name
Definition: AbstractConnection.qc.dox.h:38
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::setChildCapabilities
setChildCapabilities()
Sets child data provider capabilities.
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::getImpl
FtpClient getImpl(bool connect=True, *hash< auto > rtopts)
returns an Qore::FtpClient object
ConnectionProvider::FtpConnection::getType
string getType()
returns "ftp"
ConnectionProvider::FtpConnection::ConnectionScheme
const ConnectionScheme
Connection entry info.
Definition: FtpConnection.qc.dox.h:37
ConnectionProvider::FtpConnection::getDataProvider
DataProvider::AbstractDataProvider getDataProvider()
returns an FtpClientDataProvider object for this connection
ConnectionProvider::FtpConnection::constructor
constructor(string name, string description, string url, hash< auto > attributes={}, hash< auto > options={})
creates the FtpConnection object
ConnectionProvider::FtpConnection::getConnectionSchemeInfoImpl
hash< ConnectionSchemeInfo > getConnectionSchemeInfoImpl()
Returns the ConnectionSchemeInfo hash for this object.
ConnectionProvider
The ConnectionProvider namespace.
Definition: AbstractConnection.qc.dox.h:28
ConnectionProvider::ConnectionSchemeInfo
Connection provider information.
Definition: ConnectionSchemeCache.qc.dox.h:62