| Qore FtpClientDataProvider Module Reference 1.0

FtpClientListDataProvider.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
3
26 namespace FtpClientDataProvider {
28 class FtpClientListDataProvider : public AbstractDataProvider {
29
30 public:
32 FtpClient ftp;
33
35 const ProviderInfo = <DataProviderInfo>{
36 "name": "list",
37 "desc": "FTP list data provider; returns file information about the path given as an argument",
38 "type": "FtpClientListDataProvider",
39 "constructor_options": FtpClientDataProvider::ConstructorOptions,
40 "supports_request": True,
41 };
42
44 const ProviderSummaryInfo = cast<hash<DataProviderSummaryInfo>>(ProviderInfo{
45 AbstractDataProvider::DataProviderSummaryInfoKeys
46 });
47
49 const RequestType = new FtpClientPathDataType();
50
52 const ResponseType = new ListDataType(FtpClientStatDataProvider::ResponseType, True);
53
55 constructor(*hash<auto> options);
56
57
59 constructor(FtpClient ftp);
60
61
63 string getName();
64
65
67
74 protected:
75 auto doRequestImpl(auto req, *hash<auto> request_options);
76 public:
77
78
80
82 protected:
83 *AbstractDataProviderType getRequestTypeImpl();
84 public:
85
86
88
90 protected:
91 *AbstractDataProviderType getResponseTypeImpl();
92 public:
93
94
96 hash<DataProviderInfo> getStaticInfoImpl();
97
98 };
99 };
FtpClientDataProvider::FtpClientDataProvider::ConstructorOptions
const ConstructorOptions
Constructor arguments.
Definition: FtpClientDataProvider.qc.dox.h:42
FtpClientDataProvider::FtpClientListDataProvider
The FTP client list data provider class.
Definition: FtpClientListDataProvider.qc.dox.h:28
FtpClientDataProvider::FtpClientListDataProvider::constructor
constructor(*hash< auto > options)
Creates the object from constructor options.
FtpClientDataProvider::FtpClientListDataProvider::doRequestImpl
auto doRequestImpl(auto req, *hash< auto > request_options)
Makes a request and returns the response.
FtpClientDataProvider::FtpClientListDataProvider::getRequestTypeImpl
*AbstractDataProviderType getRequestTypeImpl()
Returns the description of a successful request message, if any.
FtpClientDataProvider::FtpClientListDataProvider::ProviderSummaryInfo
const ProviderSummaryInfo
Provider summary info.
Definition: FtpClientListDataProvider.qc.dox.h:44
FtpClientDataProvider::FtpClientListDataProvider::RequestType
const RequestType
Request type.
Definition: FtpClientListDataProvider.qc.dox.h:49
FtpClientDataProvider::FtpClientListDataProvider::getName
string getName()
Returns the data provider name.
FtpClientDataProvider::FtpClientListDataProvider::ftp
FtpClient ftp
FTP connection.
Definition: FtpClientListDataProvider.qc.dox.h:32
FtpClientDataProvider::FtpClientListDataProvider::ResponseType
const ResponseType
Response type.
Definition: FtpClientListDataProvider.qc.dox.h:52
FtpClientDataProvider::FtpClientListDataProvider::getStaticInfoImpl
hash< DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
FtpClientDataProvider::FtpClientListDataProvider::constructor
constructor(FtpClient ftp)
Creates the object from an FTP connection.
FtpClientDataProvider::FtpClientListDataProvider::getResponseTypeImpl
*AbstractDataProviderType getResponseTypeImpl()
Returns the description of a response message, if this object represents a response message.
FtpClientDataProvider::FtpClientListDataProvider::ProviderInfo
const ProviderInfo
Provider info.
Definition: FtpClientListDataProvider.qc.dox.h:35
FtpClientDataProvider::FtpClientPathDataType
Data type for FTP client stat request calls.
Definition: FtpClientPathDataType.qc.dox.h:27
FtpClientDataProvider::FtpClientStatDataProvider::ResponseType
const ResponseType
Response type.
Definition: FtpClientStatDataProvider.qc.dox.h:52
True
const True
FtpClientDataProvider
Qore FtpClientDataProvider module definition.
Definition: FtpClientCreateFileDataProvider.qc.dox.h:26