Qore ConnectionProvider Module Reference  1.2
AbstractConnection.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
2 // Qore AbstractConnection class definition
3 
4 /* AbstractConnection.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 
32 
33 public:
35  string name;
36 
38  string desc;
39 
41  string url;
42 
44  string safe_url;
45 
48 
51 
54 
57 
59  string status = "not checked";
60 
62  bool up = False;
63 
65  bool monitor;
66 
69 
71  bool loopback = False;
72 
74  static *code post_processing;
75 
77  bool enabled = True;
78 
80  bool locked = False;
81 
83 
92  deprecated
93 constructor(string n_name, string n_desc, string n_url, bool n_monitor, *hash n_opts, hash n_urlh, *string n_safe_url, *bool n_enabled);
94 
95 
97 
112  constructor(string name, string description, string url, hash attributes = {}, hash options = {});
113 
114 
115 private:
116  constructorInit(string name, string description, string url, hash attributes, hash options);
117 public:
118 
119 
121 
127  hash validateOptions(hash options);
128 
129 
131 
139 protected:
140  hash parseUrl(string url);
141 public:
142 
143 
145 
158 protected:
159  string getSafeUrl(hash urlh);
160 public:
161 
162 
164 
168  hash<PingInfo> ping(bool throw_exception = False);
169 
170 
172 protected:
173  hash<PingInfo> pingIntern(hash<PingInfo> rv);
174 public:
175 
176 
178 
182  hash<ConnectionInfo> getInfo(bool with_password = False);
183 
184 
186 
188  hash<ConfigInfo> getConfigHash();
189 
190 
192  *hash getOptions();
193 
194 
197 
198 
201 
202 
204  *hash getRealOptions();
205 
206 
208 
210  object get(bool connect = True, *hash rtopts);
211 
212 
214 
218  hash<ConnectionConstructorInfo> getConstructorInfo();
219 
220 
222 
225 
226 
228 
233 protected:
234  abstract object getImpl(bool connect = True, *hash rtopts);
235 public:
236 
238 
242 protected:
243  abstract hash<ConnectionConstructorInfo> getConstructorInfoImpl();
244 public:
245 
247  abstract string getType();
248  };
249 }; // ConnectionProvider namespace
parseTextOptions()
this method is called when parsing connection file definitions from text files when loading into the ...
*hash getRuntimeOptions()
returns runtime options
bool monitor
monitoring flag
Definition: AbstractConnection.qc.dox.h:65
date date(date dt)
date last_check
date/time of last check/ping
Definition: AbstractConnection.qc.dox.h:56
bool locked
locked/unlocked flag
Definition: AbstractConnection.qc.dox.h:80
hash< ConnectionInfo > getInfo(bool with_password=False)
returns a ConnectionInfo hash of information about the connection
abstract hash< ConnectionConstructorInfo > getConstructorInfoImpl()
this method must return a ConnectionConstructorInfo hash for creating the connection object dynamical...
abstract object getImpl(bool connect=True, *hash rtopts)
this method must return the connection object corresponding to the object&#39;s configuration ...
*hash opts
connection options
Definition: AbstractConnection.qc.dox.h:50
hash< ConnectionConstructorInfo > getConstructorInfo()
returns a ConnectionConstructorInfo hash for creating the connection object dynamically ...
const True
deprecated constructor(string n_name, string n_desc, string n_url, bool n_monitor, *hash n_opts, hash n_urlh, *string n_safe_url, *bool n_enabled)
creates the AbstractConnection object
string name
connection name
Definition: AbstractConnection.qc.dox.h:35
*hash getDefaultOptions()
returns default options
hash urlh
broken down URL hash (as returned by Qore::parse_url())
Definition: AbstractConnection.qc.dox.h:53
string getSafeUrl(hash urlh)
creates a "safe" URL string with password information removed
static *code post_processing
optional code for default post-processing of objects created by getImpl(); must take the object creat...
Definition: AbstractConnection.qc.dox.h:74
hash< PingInfo > ping(bool throw_exception=False)
returns a hash with the results of the ping operation
const False
string status
status string; in case of a connection error this string will be the error string ...
Definition: AbstractConnection.qc.dox.h:59
*hash orig_opts
original connection options
Definition: AbstractConnection.qc.dox.h:47
abstract base class for connections
Definition: AbstractConnection.qc.dox.h:31
*hash getOptions()
returns static / initialization options
string safe_url
"safe" URL (password information removed)
Definition: AbstractConnection.qc.dox.h:44
bool enabled
enabled/disabled indicator flag
Definition: AbstractConnection.qc.dox.h:77
hash parseUrl(string url)
Parse the URL to a hash.
abstract string getType()
returns the string type name for the connection object
*hash getRealOptions()
returns options for saving the connection&#39;s configuration information
hash< ConfigInfo > getConfigHash()
returns a ConfigInfo hash of static configuration information about the connection ...
string desc
connection description
Definition: AbstractConnection.qc.dox.h:38
hash validateOptions(hash options)
performs options validation in the constructor
date updated
date/time of last update
Definition: AbstractConnection.qc.dox.h:68
bool up
connection status flag; set by monitoring or explicit pings/connections
Definition: AbstractConnection.qc.dox.h:62
string url
connection URL (potentially with password info)
Definition: AbstractConnection.qc.dox.h:41
hash hash(object obj)
hash< PingInfo > pingIntern(hash< PingInfo > rv)
performs the ping by executing get(); returns a PingInfo hash
bool loopback
set to True for loopback connections
Definition: AbstractConnection.qc.dox.h:71
the ConnectionProvider namespace. All classes used in the ConnectionProvider module should be inside ...
Definition: AbstractConnection.qc.dox.h:27