Qore ssh2 Module ..
All Classes Namespaces Functions Variables Pages
SftpClientDataProvider::SftpClientDataProvider Class Reference

The SFTP client data provider class, provides API classes as children. More...

#include <SftpClientDataProvider.qc.dox.h>

Inherits AbstractDataProvider.

Public Member Methods

 constructor (*hash< auto > options)
 Creates the object from constructor options.
 
 constructor (SFTPClient sftp)
 Creates the object from an SFTP connection.
 
string getName ()
 Returns the data provider name.
 
*string getDesc ()
 Returns the data provider description.
 
*list< hash< DataProviderSummaryInfo > > getChildProviderSummaryInfo ()
 Return data provider summary info.
 

Static Public Member Methods

static SFTPClient getSftpClientConnection (hash< auto > options)
 Returns an SFTP connection from constructor options.
 
static string getPath (SFTPClient sftp, string path1)
 Returns the path based on the SftpClient's base path.
 

Public Attributes

const ProviderInfo = ...
 Provider info.
 
const ConstructorOptions = ...
 Constructor arguments.
 

Private Member Methods

*list< string > getChildProviderNamesImpl ()
 Returns a list of child data provider names, if any.
 
*AbstractDataProvider getChildProviderImpl (string name)
 Returns the given child provider or nothing if the given child is unknown.
 
hash< DataProviderInfo > getStaticInfoImpl ()
 Returns data provider static info.
 

Detailed Description

The SFTP client data provider class, provides API classes as children.

Member Function Documentation

◆ getChildProviderImpl()

*AbstractDataProvider SftpClientDataProvider::SftpClientDataProvider::getChildProviderImpl ( string  name)
private

Returns the given child provider or nothing if the given child is unknown.

Returns
the given child provider or nothing if the given child is unknown
See also
getChildProviderEx()

◆ getChildProviderNamesImpl()

*list< string > SftpClientDataProvider::SftpClientDataProvider::getChildProviderNamesImpl ( )
private

Returns a list of child data provider names, if any.

Returns
a list of child data provider names, if any

The documentation for this class was generated from the following file: