| Qore ConnectionProvider Module Reference 1.5

AbstractConnectionWithInfo.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
2 // Qore AbstractConnection class definition
3
4 /* AbstractConnectionWithInfo.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
26 namespace ConnectionProvider {
28
30 class AbstractConnectionWithInfo : public Serializable,public AbstractConnection {
31
32 public:
34
51 constructor(string name, string description, string url, hash<auto> attributes = {}, hash<auto> options = {})
52 ;
53
54
56 hash<ConnectionSchemeInfo> getConnectionSchemeInfo();
57
58
60 *hash<auto> getOptions();
61
62
64 *hash<auto> getDefaultOptions();
65
66
68 protected:
69 abstract hash<ConnectionSchemeInfo> getConnectionSchemeInfoImpl();
70 public:
71 };
72 };
ConnectionProvider::AbstractConnectionWithInfo
abstract base class for connections
Definition: AbstractConnectionWithInfo.qc.dox.h:30
ConnectionProvider::AbstractConnection::name
string name
connection name
Definition: AbstractConnection.qc.dox.h:36
ConnectionProvider::AbstractConnection
abstract base class for connections
Definition: AbstractConnection.qc.dox.h:32
ConnectionProvider::AbstractConnectionWithInfo::getOptions
*hash< auto > getOptions()
returns static / initialization options
ConnectionProvider::AbstractConnectionWithInfo::constructor
constructor(string name, string description, string url, hash< auto > attributes={}, hash< auto > options={})
creates the AbstractConnection object
ConnectionProvider::AbstractConnectionWithInfo::getConnectionSchemeInfoImpl
abstract hash< ConnectionSchemeInfo > getConnectionSchemeInfoImpl()
Returns the ConnectionSchemeInfo hash for this object.
ConnectionProvider::AbstractConnectionWithInfo::getDefaultOptions
*hash< auto > getDefaultOptions()
returns default options
ConnectionProvider::AbstractConnection::url
string url
connection URL (potentially with password info)
Definition: AbstractConnection.qc.dox.h:42
ConnectionProvider::AbstractConnectionWithInfo::getConnectionSchemeInfo
hash< ConnectionSchemeInfo > getConnectionSchemeInfo()
Returns the ConnectionSchemeInfo hash for this object.
ConnectionProvider
the ConnectionProvider namespace. All classes used in the ConnectionProvider module should be inside ...
Definition: AbstractConnection.qc.dox.h:26