Qore FtpClientDataProvider Module Reference 1.0
Loading...
Searching...
No Matches
FtpClientStatDataProvider.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
26namespace FtpClientDataProvider {
28class FtpClientStatDataProvider : public AbstractDataProvider {
29
30public:
32 FtpClient ftp;
33
35 const ProviderInfo = <DataProviderInfo>{
36 "name": "stat",
37 "desc": "FTP stat data provider; returns information about the path given as an argument",
38 "type": "FtpClientStatDataProvider",
39 "constructor_options": FtpClientDataProvider::ConstructorOptions,
40 "supports_request": True,
41 };
42
44 const ProviderSummaryInfo = cast<hash<DataProviderSummaryInfo>>(ProviderInfo{
45 AbstractDataProvider::DataProviderSummaryInfoKeys
46 });
47
50
53
55 constructor(*hash<auto> options);
56
57
59 constructor(FtpClient ftp);
60
61
63 string getName();
64
65
67 static hash<auto> doStat(FtpClient ftp, string path, *bool assume_known);
68
70 static date getModifiedTime(FtpClient ftp, string path);
71
72 static bool checkDir(FtpClient ftp, string path);
73
75
82protected:
83 auto doRequestImpl(auto req, *hash<auto> request_options);
84public:
85
86
88
90protected:
91 *AbstractDataProviderType getRequestTypeImpl();
92public:
93
94
96
98protected:
99 *AbstractDataProviderType getResponseTypeImpl();
100public:
101
102
104 hash<DataProviderInfo> getStaticInfoImpl();
105
106};
107};
const ConstructorOptions
Constructor arguments.
Definition: FtpClientDataProvider.qc.dox.h:42
Data type for FTP client stat request calls.
Definition: FtpClientPathDataType.qc.dox.h:27
The FTP client stat data provider class.
Definition: FtpClientStatDataProvider.qc.dox.h:28
constructor(*hash< auto > options)
Creates the object from constructor options.
string getName()
Returns the data provider name.
const ResponseType
Response type.
Definition: FtpClientStatDataProvider.qc.dox.h:52
constructor(FtpClient ftp)
Creates the object from an FTP connection.
const ProviderInfo
Provider info.
Definition: FtpClientStatDataProvider.qc.dox.h:35
const ProviderSummaryInfo
Provider summary info.
Definition: FtpClientStatDataProvider.qc.dox.h:44
auto doRequestImpl(auto req, *hash< auto > request_options)
Makes a request and returns the response.
hash< DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
*AbstractDataProviderType getRequestTypeImpl()
Returns the description of a successful request message, if any.
FtpClient ftp
FTP connection.
Definition: FtpClientStatDataProvider.qc.dox.h:32
static date getModifiedTime(FtpClient ftp, string path)
Returns the modified time for a remote file, if possible.
*AbstractDataProviderType getResponseTypeImpl()
Returns the description of a response message, if this object represents a response message.
const RequestType
Request type.
Definition: FtpClientStatDataProvider.qc.dox.h:49
static hash< auto > doStat(FtpClient ftp, string path, *bool assume_known)
Performs a "stat"-like action on a remote file.
Data type for FTP client stat response calls.
Definition: FtpClientStatResponseDataType.qc.dox.h:27
Qore FtpClientDataProvider module definition.
Definition: FtpClientCreateFileDataProvider.qc.dox.h:26