| Qore ConnectionProvider Module Reference 1.5

InvalidConnection.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
2 // Qore InvalidConnection class definition
3
4 /* InvalidConnection.qc Copyright 2016 - 2019 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
42
44
56 constructor(string name, string description, string url, hash attributes = {}, hash options = {})
57 ;
58
59
61
67 protected:
68 hash parseUrl(string url);
69 public:
70
71
73 protected:
74 object getImpl(bool connect = True, *hash rtopts);
75 public:
76
77
79 string getType();
80
81 };
82 }; // ConnectionProvider namespace
ConnectionProvider::InvalidConnection::parseUrl
hash parseUrl(string url)
Parse the URL to a hash.
True
const True
ConnectionProvider::AbstractConnection::name
string name
connection name
Definition: AbstractConnection.qc.dox.h:36
ConnectionProvider::AbstractConnection::urlh
hash< auto > urlh
broken down URL hash (as returned by Qore::parse_url())
Definition: AbstractConnection.qc.dox.h:54
ConnectionProvider::AbstractConnection
abstract base class for connections
Definition: AbstractConnection.qc.dox.h:32
ConnectionProvider::InvalidConnection::error
string error
Error message provided by constructor&#39;s attributes.error.
Definition: InvalidConnection.qc.dox.h:33
ConnectionProvider::InvalidConnection::getImpl
object getImpl(bool connect=True, *hash rtopts)
throws an exception because the object is invalid
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
hash
hash< auto > hash(object obj)
ConnectionProvider::AbstractConnection::url
string url
connection URL (potentially with password info)
Definition: AbstractConnection.qc.dox.h:42
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
the ConnectionProvider namespace. All classes used in the ConnectionProvider module should be inside ...
Definition: AbstractConnection.qc.dox.h:26
ConnectionProvider::InvalidConnection::getType
string getType()
returns "invalid"