Qore ConnectionProvider Module Reference  1.4
HttpConnection.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
2 // Qore HttpConnection class definition
3 
4 /* HttpConnection.qc Copyright 2016 - 2020 Qore Technologies, s.r.o.
5 
6  Permission is hereby granted, free of charge, to any person obtaining a
7  copy of this software and associated documentation files (the "Software"),
8  to deal in the Software without restriction, including without limitation
9  the rights to use, copy, modify, merge, publish, distribute, sublicense,
10  and/or sell copies of the Software, and to permit persons to whom the
11  Software is furnished to do so, subject to the following conditions:
12 
13  The above copyright notice and this permission notice shall be included in
14  all copies or substantial portions of the Software.
15 
16  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22  DEALINGS IN THE SOFTWARE.
23 */
24 
25 
27 namespace ConnectionProvider {
29 
49 
50 public:
52  const ConnectionScheme = ...;
53 
54 
56  const Options = map {$1: True}, keys ConnectionScheme.options;
57 
59  const DefaultOptions = ...;
60 
61 
63 
73  constructor(string name, string desc, string url, hash<auto> attributes = {}, hash<auto> options = {})
74  ;
75 
76 
78  string getType();
79 
80 
82 
85 protected:
86  Qore::HTTPClient getImpl(bool connect = True, *hash<auto> rtopts);
87 public:
88 
89 
91 protected:
92  hash<ConnectionSchemeInfo> getConnectionSchemeInfoImpl();
93 public:
94 
95 };
96 }; // ConnectionProvider namespace
ConnectionProvider
the ConnectionProvider namespace. All classes used in the ConnectionProvider module should be inside ...
Definition: AbstractConnection.qc.dox.h:26
Qore::HTTPClient
ConnectionProvider::AbstractConnection::name
string name
connection name
Definition: AbstractConnection.qc.dox.h:36
ConnectionProvider::HttpConnection::DefaultOptions
const DefaultOptions
HttpConnection default options.
Definition: HttpConnection.qc.dox.h:59
ConnectionProvider::AbstractConnection::desc
string desc
connection description
Definition: AbstractConnection.qc.dox.h:39
True
const True
ConnectionProvider::HttpConnection::Options
const Options
HttpConnection object connection options.
Definition: HttpConnection.qc.dox.h:56
ConnectionProvider::AbstractConnectionWithInfo
abstract base class for connections
Definition: AbstractConnectionWithInfo.qc.dox.h:30
ConnectionProvider::HttpConnection::getType
string getType()
returns "http"
ConnectionProvider::HttpConnection::getImpl
Qore::HTTPClient getImpl(bool connect=True, *hash< auto > rtopts)
returns an Qore::HTTPClient object
ConnectionProvider::HttpConnection::constructor
constructor(string name, string desc, string url, hash< auto > attributes={}, hash< auto > options={})
creates the HttpConnection object
ConnectionProvider::HttpConnection::ConnectionScheme
const ConnectionScheme
Connection entry info.
Definition: HttpConnection.qc.dox.h:52
ConnectionProvider::AbstractConnection::url
string url
connection URL (potentially with password info)
Definition: AbstractConnection.qc.dox.h:42
ConnectionProvider::HttpConnection
class for HTTP connections; returns Qore::HTTPClient objects
Definition: HttpConnection.qc.dox.h:48
ConnectionProvider::HttpConnection::getConnectionSchemeInfoImpl
hash< ConnectionSchemeInfo > getConnectionSchemeInfoImpl()
Returns the ConnectionSchemeInfo hash for this object.