Loading...
Searching...
No Matches
HttpClientGetDataProvider.qc.dox.h
// -*- mode: c++; indent-tabs-mode: nil -*-
namespace HttpClientDataProvider {
class HttpClientGetDataProvider : public AbstractDataProvider {
public:
HTTPClient http;
const ProviderInfo = <DataProviderInfo>{
"name": "get",
"desc": "HTTP GET data provider; makes a `GET` request to an HTTP server and returns the response",
"type": "HttpClientGetDataProvider",
"constructor_options": HttpClientDataProvider::ConstructorOptions,
"supports_request": True,
};
const ProviderSummaryInfo = cast<hash<DataProviderSummaryInfo>>(ProviderInfo{
AbstractDataProvider::DataProviderSummaryInfoKeys
});
const RequestType = new HttpClientCallWithoutBodyRequestDataType();
const ResponseType = new HttpClientCallResponseDataType();
constructor(*hash<auto> options);
constructor(HTTPClient http);
string getName();
protected:
auto doRequestImpl(auto req, *hash<auto> request_options);
public:
protected:
*AbstractDataProviderType getRequestTypeImpl();
public:
protected:
*AbstractDataProviderType getResponseTypeImpl();
public:
hash<DataProviderInfo> getStaticInfoImpl();
};
};
HttpClientDataProvider::HttpClientCallResponseDataType
Data type for HTTP call responses.
Definition: HttpClientCallResponseDataType.qc.dox.h:27
HttpClientDataProvider::HttpClientCallWithoutBodyRequestDataType
Data type for HTTP call requests with no message bodies.
Definition: HttpClientCallWithoutBodyRequestDataType.qc.dox.h:27
HttpClientDataProvider::HttpClientDataProvider::ConstructorOptions
const ConstructorOptions
Constructor arguments.
Definition: HttpClientDataProvider.qc.dox.h:42
HttpClientDataProvider::HttpClientGetDataProvider
The HTTP get data provider class.
Definition: HttpClientGetDataProvider.qc.dox.h:28
HttpClientDataProvider::HttpClientGetDataProvider::getName
string getName()
Returns the data provider name.
HttpClientDataProvider::HttpClientGetDataProvider::doRequestImpl
auto doRequestImpl(auto req, *hash< auto > request_options)
Makes a request and returns the response.
HttpClientDataProvider::HttpClientGetDataProvider::ResponseType
const ResponseType
Response type.
Definition: HttpClientGetDataProvider.qc.dox.h:52
HttpClientDataProvider::HttpClientGetDataProvider::http
HTTPClient http
HTTP connection.
Definition: HttpClientGetDataProvider.qc.dox.h:32
HttpClientDataProvider::HttpClientGetDataProvider::constructor
constructor(*hash< auto > options)
Creates the object from constructor options.
HttpClientDataProvider::HttpClientGetDataProvider::ProviderSummaryInfo
const ProviderSummaryInfo
Provider summary info.
Definition: HttpClientGetDataProvider.qc.dox.h:44
HttpClientDataProvider::HttpClientGetDataProvider::ProviderInfo
const ProviderInfo
Provider info.
Definition: HttpClientGetDataProvider.qc.dox.h:35
HttpClientDataProvider::HttpClientGetDataProvider::RequestType
const RequestType
Request type.
Definition: HttpClientGetDataProvider.qc.dox.h:49
HttpClientDataProvider::HttpClientGetDataProvider::getRequestTypeImpl
*AbstractDataProviderType getRequestTypeImpl()
HttpClientDataProvider::HttpClientGetDataProvider::getStaticInfoImpl
hash< DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
HttpClientDataProvider::HttpClientGetDataProvider::constructor
constructor(HTTPClient http)
Creates the object from an HTTP connection.
HttpClientDataProvider::HttpClientGetDataProvider::getResponseTypeImpl
*AbstractDataProviderType getResponseTypeImpl()
Returns the description of a response message, if this object represents a response message.
HttpClientDataProvider
Qore HttpClientDataProvider module definition.
Definition: HttpClientCallDataProvider.qc.dox.h:26