| Qore ConnectionProvider Module Reference 2.0.1

Loading...
Searching...
No Matches
InvalidConnection.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
2// Qore InvalidConnection class definition
3
4/* InvalidConnection.qc Copyright 2016 - 2024 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 class InvalidConnection : public AbstractConnection {
30
31 public:
33 string error = "unknown error";
34
36
38 deprecated
39 constructor(string n_name, string n_desc, string n_url, *hash n_opts, string n_error, hash urlh) ;
40
41
43
55 constructor(string name, string description, string url, hash<auto> attributes = {}, hash<auto> options = {}, *Logger logger) ;
56
57
59
76 constructor(hash<auto> config, *hash<auto> attr) ;
77
78
80
88 protected:
89 hash<UrlInfo> parseUrl(string url);
90 public:
91
92
94 protected:
95 object getImpl(bool connect = True, *hash<auto> rtopts);
96 public:
97
98
100 string getType();
101
102};
103}; // ConnectionProvider namespace
ConnectionProvider::AbstractConnection
Abstract base class for connections.
Definition AbstractConnection.qc.dox.h:69
ConnectionProvider::AbstractConnection::url
string url
Connection URL (potentially with password info)
Definition AbstractConnection.qc.dox.h:85
ConnectionProvider::AbstractConnection::name
string name
Connection name.
Definition AbstractConnection.qc.dox.h:73
ConnectionProvider::AbstractConnection::urlh
hash< auto > urlh
broken down URL hash (as returned by Qore::parse_url())
Definition AbstractConnection.qc.dox.h:100
ConnectionProvider::InvalidConnection
this class is used to mark invalid connections so they can be loaded and reported as invalid
Definition InvalidConnection.qc.dox.h:29
ConnectionProvider::InvalidConnection::error
string error
Error message provided by constructor's attributes.error.
Definition InvalidConnection.qc.dox.h:33
ConnectionProvider::InvalidConnection::constructor
constructor(string name, string description, string url, hash< auto > attributes={}, hash< auto > options={}, *Logger logger)
creates the invalid connection object
ConnectionProvider::InvalidConnection::constructor
constructor(hash< auto > config, *hash< auto > attr)
creates the invalid connection object
ConnectionProvider::InvalidConnection::constructor
deprecated constructor(string n_name, string n_desc, string n_url, *hash n_opts, string n_error, hash urlh)
DEPRECATED: creates the invalid connection object.
ConnectionProvider::InvalidConnection::getType
string getType()
returns "invalid"
ConnectionProvider::InvalidConnection::parseUrl
hash< UrlInfo > parseUrl(string url)
Parse the URL to a hash.
ConnectionProvider::InvalidConnection::getImpl
object getImpl(bool connect=True, *hash< auto > rtopts)
throws an exception because the object is invalid
ConnectionProvider
The ConnectionProvider namespace.
Definition AbstractConnection.qc.dox.h:28