| Qore FtpClientDataProvider Module Reference 1.0

FtpClientGetFileDataProvider.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
3
26 namespace FtpClientDataProvider {
28 class FtpClientGetFileDataProvider : public AbstractDataProvider {
29
30 public:
32 FtpClient ftp;
33
35 const ProviderInfo = <DataProviderInfo>{
36 "name": "get-file",
37 "desc": "FTP get file data provider; gets a file in the given location",
38 "type": "FtpClientGetFileDataProvider",
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 FtpClientGetFileRequestDataType();
50
52 const ResponseType = new FtpClientGetFileResponseDataType();
53
55 constructor(*hash<auto> options);
56
57
59 constructor(FtpClient ftp);
60
61
63 string getName();
64
65
67
72 protected:
73 auto doRequestImpl(auto req, *hash<auto> request_options);
74 public:
75
76
78
80 protected:
81 *AbstractDataProviderType getRequestTypeImpl();
82 public:
83
84
86
88 protected:
89 *AbstractDataProviderType getResponseTypeImpl();
90 public:
91
92
94 hash<DataProviderInfo> getStaticInfoImpl();
95
96 };
97 };
FtpClientDataProvider::FtpClientDataProvider::ConstructorOptions
const ConstructorOptions
Constructor arguments.
Definition: FtpClientDataProvider.qc.dox.h:42
FtpClientDataProvider::FtpClientGetFileDataProvider
The FTP client get file data provider class.
Definition: FtpClientGetFileDataProvider.qc.dox.h:28
FtpClientDataProvider::FtpClientGetFileDataProvider::getRequestTypeImpl
*AbstractDataProviderType getRequestTypeImpl()
Returns the description of a successful request message, if any.
FtpClientDataProvider::FtpClientGetFileDataProvider::ProviderInfo
const ProviderInfo
Provider info.
Definition: FtpClientGetFileDataProvider.qc.dox.h:35
FtpClientDataProvider::FtpClientGetFileDataProvider::ftp
FtpClient ftp
FTP connection.
Definition: FtpClientGetFileDataProvider.qc.dox.h:32
FtpClientDataProvider::FtpClientGetFileDataProvider::getName
string getName()
Returns the data provider name.
FtpClientDataProvider::FtpClientGetFileDataProvider::constructor
constructor(*hash< auto > options)
Gets the object from constructor options.
FtpClientDataProvider::FtpClientGetFileDataProvider::doRequestImpl
auto doRequestImpl(auto req, *hash< auto > request_options)
Makes a request and returns the response.
FtpClientDataProvider::FtpClientGetFileDataProvider::ResponseType
const ResponseType
Response type.
Definition: FtpClientGetFileDataProvider.qc.dox.h:52
FtpClientDataProvider::FtpClientGetFileDataProvider::getResponseTypeImpl
*AbstractDataProviderType getResponseTypeImpl()
Returns the description of a response message, if this object represents a response message.
FtpClientDataProvider::FtpClientGetFileDataProvider::ProviderSummaryInfo
const ProviderSummaryInfo
Provider summary info.
Definition: FtpClientGetFileDataProvider.qc.dox.h:44
FtpClientDataProvider::FtpClientGetFileDataProvider::getStaticInfoImpl
hash< DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
FtpClientDataProvider::FtpClientGetFileDataProvider::RequestType
const RequestType
Request type.
Definition: FtpClientGetFileDataProvider.qc.dox.h:49
FtpClientDataProvider::FtpClientGetFileDataProvider::constructor
constructor(FtpClient ftp)
Gets the object from an FTP connection.
FtpClientDataProvider::FtpClientGetFileRequestDataType
Data type for FTP client get file request calls.
Definition: FtpClientGetFileRequestDataType.qc.dox.h:27
FtpClientDataProvider::FtpClientGetFileResponseDataType
Data type for FTP client get file request calls.
Definition: FtpClientGetFileResponseDataType.qc.dox.h:27
True
const True
FtpClientDataProvider
Qore FtpClientDataProvider module definition.
Definition: FtpClientCreateFileDataProvider.qc.dox.h:26