| Qore ConnectionProvider Module Reference 1.4

ConnectionProvider.qm.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
3
4 /* ConnectionProvider.qm 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 // minimum required Qore module
26
27
28
29
128 namespace ConnectionProvider {
130
134 public struct ConnectionConstructorInfo {
136 *string module;
137
139 string class_name;
140
142 *softlist<auto> args;
143
145
155 *string post_processing;
156
158
168 *string pre_processing;
169 };
170
172 public struct ConnectionInfo {
173 string name;
174 string desc;
175 *date last_check;
176 bool loopback;
177 bool monitor;
178 *hash opts;
179 string status;
180 string type;
181 bool up = False;
182 *date updated;
183 string url;
184 hash url_hash;
185 bool enabled;
186 bool locked;
187 bool debug_data;
188 hash<auto> tags;
189 bool has_provider = False;
190 };
191
193 public struct ConfigInfo {
194 string name;
195 string desc;
196 string url;
197 *hash opts;
198 };
199
201 public struct PingInfo {
202 string name;
203 string desc;
204 *hash opts;
205 string url;
206 bool ok;
207 date time;
208 string info;
209 *hash ping_info;
210 *hash<ExceptionInfo> ex;
211 };
212
214
229 string get_connection_url(string str);
230
231
233
248 AbstractConnection get_connection(string conn);
249
250
252
267 *hash<string, AbstractConnection> get_connections(*bool verbose);
268
269
271
286 *hash<string, hash<ConnectionInfo>> get_connection_hash(*bool verbose);
287
288 }; // ConnectionProvider namespace
289
290 // private, non-exported namespace
291 namespace Priv {
292 *hash priv_try_get_connections(string mod);
293
294
295 ConnectionProvider::AbstractConnection priv_try_get_connection(string mod, string conn);
296
297 }; // Priv nsmrspace
ConnectionProvider::AbstractConnection
abstract base class for connections
Definition: AbstractConnection.qc.dox.h:32
False
const False
date
date date(date dt)
hash
hash< auto > hash(object obj)
ConnectionProvider
the ConnectionProvider namespace. All classes used in the ConnectionProvider module should be inside ...
Definition: AbstractConnection.qc.dox.h:26
ConnectionProvider::get_connection_url
string get_connection_url(string str)
returns a URL string for the given identifier if the identifier is known to a registered connection p...
ConnectionProvider::get_connections
*hash< string, AbstractConnection > get_connections(*bool verbose)
returns all known connections as a hash keyed by connection identifier; values are AbstractConnection...
ConnectionProvider::get_connection_hash
*hash< string, hash< ConnectionInfo > > get_connection_hash(*bool verbose)
returns a hash of connection information keyed by connection identifier; values are ConnectionInfo ha...
ConnectionProvider::get_connection
AbstractConnection get_connection(string conn)
returns an AbstractConnection object if the identifier is known to a registered connection provider
ConnectionProvider::ConfigInfo
config informaton as returned by AbstractConnection::getConfigHash()
Definition: ConnectionProvider.qm.dox.h:193
ConnectionProvider::ConfigInfo::opts
*hash opts
the options set on the connection
Definition: ConnectionProvider.qm.dox.h:197
ConnectionProvider::ConfigInfo::name
string name
the name of the connection
Definition: ConnectionProvider.qm.dox.h:194
ConnectionProvider::ConfigInfo::desc
string desc
the description
Definition: ConnectionProvider.qm.dox.h:195
ConnectionProvider::ConfigInfo::url
string url
the full URL (including any username & password)
Definition: ConnectionProvider.qm.dox.h:196
ConnectionProvider::ConnectionConstructorInfo
information that can be used to dynamically construct a connection object
Definition: ConnectionProvider.qm.dox.h:134
ConnectionProvider::ConnectionConstructorInfo::class_name
string class_name
the name of the constructor's class
Definition: ConnectionProvider.qm.dox.h:139
ConnectionProvider::ConnectionConstructorInfo::module
*string module
any module required to be loaded for the constructor call
Definition: ConnectionProvider.qm.dox.h:136
ConnectionProvider::ConnectionConstructorInfo::pre_processing
*string pre_processing
code to execute before construction to preprocess the constructor arguments
Definition: ConnectionProvider.qm.dox.h:168
ConnectionProvider::ConnectionConstructorInfo::post_processing
*string post_processing
code to execute after construction
Definition: ConnectionProvider.qm.dox.h:155
ConnectionProvider::ConnectionConstructorInfo::args
*softlist< auto > args
the constructor arguments
Definition: ConnectionProvider.qm.dox.h:142
ConnectionProvider::ConnectionInfo
connection information hash as returned by AbstractConnection::getInfo()
Definition: ConnectionProvider.qm.dox.h:172
ConnectionProvider::ConnectionInfo::tags
hash< auto > tags
user-defined key-value pairs associated with the connection
Definition: ConnectionProvider.qm.dox.h:188
ConnectionProvider::ConnectionInfo::loopback
bool loopback
a boolean vaue indicating if the connection is a loopback connection
Definition: ConnectionProvider.qm.dox.h:176
ConnectionProvider::ConnectionInfo::has_provider
bool has_provider
if the connection supports the data provider API
Definition: ConnectionProvider.qm.dox.h:189
ConnectionProvider::ConnectionInfo::last_check
*date last_check
the date/time value of the last connection check (or NOTHING if not checked)
Definition: ConnectionProvider.qm.dox.h:175
ConnectionProvider::ConnectionInfo::opts
*hash opts
the original options used to create the object
Definition: ConnectionProvider.qm.dox.h:178
ConnectionProvider::ConnectionInfo::monitor
bool monitor
a boolean vaue indicating if the connection should be monitored or not
Definition: ConnectionProvider.qm.dox.h:177
ConnectionProvider::ConnectionInfo::up
bool up
a boolean vaue indicating the connection is known to be up (will be False if not checked)
Definition: ConnectionProvider.qm.dox.h:181
ConnectionProvider::ConnectionInfo::locked
bool locked
a boolean value indicating whether the connection is locked or not. This flag does not affect anythin...
Definition: ConnectionProvider.qm.dox.h:186
ConnectionProvider::ConnectionInfo::name
string name
the connection name
Definition: ConnectionProvider.qm.dox.h:173
ConnectionProvider::ConnectionInfo::type
string type
the connection type
Definition: ConnectionProvider.qm.dox.h:180
ConnectionProvider::ConnectionInfo::updated
*date updated
the date/time value of the update (or NOTHING if not updated)
Definition: ConnectionProvider.qm.dox.h:182
ConnectionProvider::ConnectionInfo::enabled
bool enabled
a boolean value indicating if the connection should be enabled or not. This flag does not affect anyt...
Definition: ConnectionProvider.qm.dox.h:185
ConnectionProvider::ConnectionInfo::debug_data
bool debug_data
a boolean value indicating whether the connection should be subject to data debugging....
Definition: ConnectionProvider.qm.dox.h:187
ConnectionProvider::ConnectionInfo::status
string status
a string giving the connection's status
Definition: ConnectionProvider.qm.dox.h:179
ConnectionProvider::ConnectionInfo::desc
string desc
the connection description
Definition: ConnectionProvider.qm.dox.h:174
ConnectionProvider::ConnectionInfo::url
string url
the URL for the connection including the password (if any present and the with_password argument is T...
Definition: ConnectionProvider.qm.dox.h:183
ConnectionProvider::ConnectionInfo::url_hash
hash url_hash
a hash of URL information as returned by parse_url()
Definition: ConnectionProvider.qm.dox.h:184
ConnectionProvider::PingInfo
ping response info as returned by AbstractConnection::ping()
Definition: ConnectionProvider.qm.dox.h:201
ConnectionProvider::PingInfo::time
date time
a relative date/time value giving the elapsed time of the ping operation
Definition: ConnectionProvider.qm.dox.h:207
ConnectionProvider::PingInfo::desc
string desc
the description
Definition: ConnectionProvider.qm.dox.h:203
ConnectionProvider::PingInfo::ping_info
*hash ping_info
an optional free-form hash giving additional info regarding ping operation or the remote system
Definition: ConnectionProvider.qm.dox.h:209
ConnectionProvider::PingInfo::ok
bool ok
a boolean value giving the result of the ping
Definition: ConnectionProvider.qm.dox.h:206
ConnectionProvider::PingInfo::ex
*hash< ExceptionInfo > ex
if an exception occured, all exception info will be returned here
Definition: ConnectionProvider.qm.dox.h:210
ConnectionProvider::PingInfo::opts
*hash opts
the options set on the connection
Definition: ConnectionProvider.qm.dox.h:204
ConnectionProvider::PingInfo::url
string url
a safe version of the URL (without passwords)
Definition: ConnectionProvider.qm.dox.h:205
ConnectionProvider::PingInfo::name
string name
the name of the connection
Definition: ConnectionProvider.qm.dox.h:202
ConnectionProvider::PingInfo::info
string info
a string giving the result of the ping ("OK" or an error message)
Definition: ConnectionProvider.qm.dox.h:208