$darkmode
Qore FtpClientDataProvider Module Reference 1.0
FtpClientMoveDataProvider.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
3 
26 namespace FtpClientDataProvider {
28 class FtpClientMoveDataProvider : public AbstractDataProvider {
29 
30 public:
32  FtpClient ftp;
33 
35  const ProviderInfo = <DataProviderInfo>{
36  "name": "move",
37  "desc": "FTP move data provider; moves a file on a remote FTP server given the source and target paths "
38  "as arguments",
39  "type": "FtpClientMoveDataProvider",
40  "constructor_options": FtpClientDataProvider::ConstructorOptions,
41  "supports_request": True,
42  };
43 
45  const ProviderSummaryInfo = cast<hash<DataProviderSummaryInfo>>(ProviderInfo{
46  AbstractDataProvider::DataProviderSummaryInfoKeys
47  });
48 
51 
54 
56  constructor(*hash<auto> options);
57 
58 
60  constructor(FtpClient ftp);
61 
62 
64  string getName();
65 
66 
68 
73 protected:
74  auto doRequestImpl(auto req, *hash<auto> request_options);
75 public:
76 
77 
79 
81 protected:
82  *AbstractDataProviderType getRequestTypeImpl();
83 public:
84 
85 
87 
89 protected:
90  *AbstractDataProviderType getResponseTypeImpl();
91 public:
92 
93 
95  hash<DataProviderInfo> getStaticInfoImpl();
96 
97 };
98 };
const ConstructorOptions
Constructor arguments.
Definition: FtpClientDataProvider.qc.dox.h:42
The FTP client move data provider class.
Definition: FtpClientMoveDataProvider.qc.dox.h:28
FtpClient ftp
FTP connection.
Definition: FtpClientMoveDataProvider.qc.dox.h:32
hash< DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
constructor(FtpClient ftp)
Creates the object from an FTP connection.
const ProviderSummaryInfo
Provider summary info.
Definition: FtpClientMoveDataProvider.qc.dox.h:45
const ProviderInfo
Provider info.
Definition: FtpClientMoveDataProvider.qc.dox.h:35
const RequestType
Request type.
Definition: FtpClientMoveDataProvider.qc.dox.h:50
constructor(*hash< auto > options)
Creates the object from constructor options.
*AbstractDataProviderType getRequestTypeImpl()
Returns the description of a successful request message, if any.
auto doRequestImpl(auto req, *hash< auto > request_options)
Makes a request and returns the response.
string getName()
Returns the data provider name.
*AbstractDataProviderType getResponseTypeImpl()
Returns the description of a response message, if this object represents a response message.
const ResponseType
Response type.
Definition: FtpClientMoveDataProvider.qc.dox.h:53
Data type for FTP client get file request calls.
Definition: FtpClientMoveRequestDataType.qc.dox.h:27
Data type for FTP client stat request calls.
Definition: FtpClientPathDataType.qc.dox.h:27
const True
Qore FtpClientDataProvider module definition.
Definition: FtpClientCreateFileDataProvider.qc.dox.h:26