Qore HttpClientDataProvider Module Reference 1.1
Loading...
Searching...
No Matches
HttpClientOptionsDataProvider.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
26namespace HttpClientDataProvider {
28class HttpClientOptionsDataProvider : public AbstractDataProvider {
29
30public:
32 HTTPClient http;
33
35 const ProviderInfo = <DataProviderInfo>{
36 "name": "options",
37 "desc": "HTTP OPTIONS data provider; makes an `OPTIONS` request to an HTTP server and returns the response",
38 "type": "HttpClientOptionsDataProvider",
39 "constructor_options": HttpClientDataProvider::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(HTTPClient http);
60
61
63 string getName();
64
65
67
72protected:
73 auto doRequestImpl(auto req, *hash<auto> request_options);
74public:
75
76
79
81protected:
82 *AbstractDataProviderType getRequestTypeImpl();
83public:
84
85
87
89protected:
90 *AbstractDataProviderType getResponseTypeImpl();
91public:
92
93
95 hash<DataProviderInfo> getStaticInfoImpl();
96
97};
98};
Data type for HTTP call responses.
Definition: HttpClientCallResponseDataType.qc.dox.h:27
Data type for HTTP call requests with no message bodies.
Definition: HttpClientCallWithoutBodyRequestDataType.qc.dox.h:27
const ConstructorOptions
Constructor arguments.
Definition: HttpClientDataProvider.qc.dox.h:42
The HTTP options data provider class.
Definition: HttpClientOptionsDataProvider.qc.dox.h:28
string getName()
Returns the data provider name.
const RequestType
Request type.
Definition: HttpClientOptionsDataProvider.qc.dox.h:49
constructor(*hash< auto > options)
Creates the object from constructor options.
const ProviderInfo
Provider info.
Definition: HttpClientOptionsDataProvider.qc.dox.h:35
auto doRequestImpl(auto req, *hash< auto > request_options)
Makes a request and returns the response.
hash< DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
const ResponseType
Response type.
Definition: HttpClientOptionsDataProvider.qc.dox.h:52
constructor(HTTPClient http)
Creates the object from an HTTP connection.
*AbstractDataProviderType getResponseTypeImpl()
Returns the description of a response message, if this object represents a response message.
const ProviderSummaryInfo
Provider summary info.
Definition: HttpClientOptionsDataProvider.qc.dox.h:44
HTTPClient http
HTTP connection.
Definition: HttpClientOptionsDataProvider.qc.dox.h:32
Qore HttpClientDataProvider module definition.
Definition: HttpClientCallDataProvider.qc.dox.h:26