Qore FtpClientDataProvider Module Reference  1.0
FtpClientDataProvider::FtpClientGetFileDataProvider Class Reference

The FTP client get file data provider class. More...

Inherits AbstractDataProvider.

Public Member Functions

 constructor (*hash< auto > options)
 Gets the object from constructor options.
 
 constructor (FtpClient ftp)
 Gets the object from an FTP connection.
 
string getName ()
 Returns the data provider name.
 
hash< DataProviderInfo > getStaticInfoImpl ()
 Returns data provider static info.
 

Public Attributes

FtpClient ftp
 FTP connection.
 
const ProviderInfo
 Provider info.
 
const ProviderSummaryInfo
 Provider summary info.
 
const RequestType = new FtpClientGetFileRequestDataType()
 Request type.
 
const ResponseType = new FtpClientGetFileResponseDataType()
 Response type.
 

Protected Member Functions

auto doRequestImpl (auto req, *hash< auto > request_options)
 Makes a request and returns the response. More...
 
*AbstractDataProviderType getRequestTypeImpl ()
 Returns the description of a successful request message, if any. More...
 
*AbstractDataProviderType getResponseTypeImpl ()
 Returns the description of a response message, if this object represents a response message. More...
 

Detailed Description

The FTP client get file data provider class.

Member Function Documentation

◆ doRequestImpl()

auto FtpClientDataProvider::FtpClientGetFileDataProvider::doRequestImpl ( auto  req,
*hash< auto >  request_options 
)
protected

Makes a request and returns the response.

Parameters
reqthe request info
request_optionsthe request options; will be processed by validateRequestOptions()
Returns
the response to the request

◆ getRequestTypeImpl()

*AbstractDataProviderType FtpClientDataProvider::FtpClientGetFileDataProvider::getRequestTypeImpl ( )
protected

Returns the description of a successful request message, if any.

Returns
the request type for this provider

◆ getResponseTypeImpl()

*AbstractDataProviderType FtpClientDataProvider::FtpClientGetFileDataProvider::getResponseTypeImpl ( )
protected

Returns the description of a response message, if this object represents a response message.

Returns
the response type for this response message
tdef">Definition: RestClientGetDataProvider.qc.dox.h:35
RestClientDataProvider::RestClientGetDataProvider::ProviderSummaryInfo
const ProviderSummaryInfo
Provider summary info.
Definition: RestClientGetDataProvider.qc.dox.h:44
RestClientDataProvider::RestClientGetDataProvider::doRequestImpl
auto doRequestImpl(auto req, *hash< auto > request_options)
Makes a request and returns the response.
RestClientDataProvider::RestClientGetDataProvider::rest
RestClient rest
REST client connection.
Definition: RestClientGetDataProvider.qc.dox.h:32
RestClientDataProvider::RestClientGetDataProvider::getRequestTypeImpl
*AbstractDataProviderType getRequestTypeImpl()
RestClientDataProvider::RestClientGetDataProvider::constructor
constructor(RestClient rest)
Creates the object from a REST connection.
RestClientDataProvider::RestClientGetDataProvider::constructor
constructor(*hash< auto > options)
Creates the object from constructor options.
RestClientDataProvider::RestClientGetDataProvider::ResponseType
const ResponseType
Response type.
Definition: RestClientGetDataProvider.qc.dox.h:52
RestClientDataProvider::RestClientGetDataProvider::getName
string getName()
Returns the data provider name.
RestClientDataProvider::RestClientGetDataProvider::RequestType
const RequestType
Request type.
Definition: RestClientGetDataProvider.qc.dox.h:49
RestClientDataProvider::RestClientGetDataProvider::getStaticInfoImpl
hash< DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
True
const True
RestClientDataProvider
Qore RestClientDataProvider module definition.
Definition: RestClientCallDataProvider.qc.dox.h:26
RestClient