$darkmode

| Qore ConnectionProvider Module Reference 1.7.4

ConnectionProvider.qm.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
4/* ConnectionProvider.qm Copyright 2016 - 2023 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
184
186 namespace ConnectionProvider {
188
192 public struct ConnectionConstructorInfo {
194 *string module;
195
197 string class_name;
198
200 *softlist<auto> args;
201
203
213 *string post_processing;
214
216
226 *string pre_processing;
227};
228
230
232 public struct ConnectionInfo {
234 string name;
235
237 string desc;
238
240 *date last_check;
241
243 bool loopback;
244
246 bool monitor;
247
249 *hash opts;
250
252 string status;
253
255 string type;
256
258 bool up = False;
259
261 *date updated;
262
264
266 string url;
267
269 hash url_hash;
270
272
274 bool enabled;
275
277
279 bool locked;
280
282
284 bool debug_data;
285
287 hash<auto> tags;
288
290 bool has_provider = False;
291
293 bool children_can_support_apis = False;
294
296 bool children_can_support_records = False;
297
299 bool children_can_support_observers = False;
300
302 bool children_can_support_messages = False;
303};
304
306
308 public struct ConfigInfo {
309 string name;
310 string desc;
311 string url;
312 *hash opts;
313};
314
316
318 public struct PingInfo {
319 string name;
321
322 string desc;
324
325 *hash opts;
327
328 string url;
330
331 bool ok;
333
334 date time;
336
337 string info;
339
340 *hash ping_info;
342
344 *hash<ExceptionInfo> ex;
345};
346
348
363 string get_connection_url(string str);
364
365
367
382 AbstractConnection get_connection(string conn);
383
384
386
401 *hash<string, AbstractConnection> get_connections(*bool verbose);
402
403
405
420 *hash<string, hash<ConnectionInfo>> get_connection_hash(*bool verbose);
421
422}; // ConnectionProvider namespace
423
424// private, non-exported namespace
425 namespace Priv {
426*hash priv_try_get_connections(string mod);
427
428
429 ConnectionProvider::AbstractConnection priv_try_get_connection(string mod, string conn);
430
431}; // Priv nsmrspace
ConnectionProvider::AbstractConnection
abstract base class for connections
Definition: AbstractConnection.qc.dox.h:34
False
const False
date
date date(date dt)
hash
hash< auto > hash(object obj)
ConnectionProvider
The ConnectionProvider namespace.
Definition: AbstractConnection.qc.dox.h:28
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
AbstractConnection get_connection(string conn)
returns an AbstractConnection object if the identifier is known to a registered connection provider
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::ConfigInfo
config informaton
Definition: ConnectionProvider.qm.dox.h:308
ConnectionProvider::ConfigInfo::opts
*hash opts
the options set on the connection
Definition: ConnectionProvider.qm.dox.h:312
ConnectionProvider::ConfigInfo::name
string name
the name of the connection
Definition: ConnectionProvider.qm.dox.h:309
ConnectionProvider::ConfigInfo::desc
string desc
the description
Definition: ConnectionProvider.qm.dox.h:310
ConnectionProvider::ConfigInfo::url
string url
the full URL (including any username & password)
Definition: ConnectionProvider.qm.dox.h:311
ConnectionProvider::ConnectionConstructorInfo
information that can be used to dynamically construct a connection object
Definition: ConnectionProvider.qm.dox.h:192
ConnectionProvider::ConnectionConstructorInfo::class_name
string class_name
the name of the constructor's class
Definition: ConnectionProvider.qm.dox.h:197
ConnectionProvider::ConnectionConstructorInfo::module
*string module
any module required to be loaded for the constructor call
Definition: ConnectionProvider.qm.dox.h:194
ConnectionProvider::ConnectionConstructorInfo::pre_processing
*string pre_processing
code to execute before construction to preprocess the constructor arguments
Definition: ConnectionProvider.qm.dox.h:226
ConnectionProvider::ConnectionConstructorInfo::post_processing
*string post_processing
code to execute after construction
Definition: ConnectionProvider.qm.dox.h:213
ConnectionProvider::ConnectionConstructorInfo::args
*softlist< auto > args
the constructor arguments
Definition: ConnectionProvider.qm.dox.h:200
ConnectionProvider::ConnectionInfo
connection information hash
Definition: ConnectionProvider.qm.dox.h:232
ConnectionProvider::ConnectionInfo::tags
hash< auto > tags
user-defined key-value pairs associated with the connection
Definition: ConnectionProvider.qm.dox.h:287
ConnectionProvider::ConnectionInfo::children_can_support_records
bool children_can_support_records
if the data provider or any of its children support records
Definition: ConnectionProvider.qm.dox.h:296
ConnectionProvider::ConnectionInfo::loopback
bool loopback
a boolean vaue indicating if the connection is a loopback connection
Definition: ConnectionProvider.qm.dox.h:243
ConnectionProvider::ConnectionInfo::has_provider
bool has_provider
if the connection supports the data provider API
Definition: ConnectionProvider.qm.dox.h:290
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:240
ConnectionProvider::ConnectionInfo::opts
*hash opts
the original options used to create the object
Definition: ConnectionProvider.qm.dox.h:249
ConnectionProvider::ConnectionInfo::children_can_support_apis
bool children_can_support_apis
if the data provider or any of its children support requests (APIs)
Definition: ConnectionProvider.qm.dox.h:293
ConnectionProvider::ConnectionInfo::monitor
bool monitor
a boolean vaue indicating if the connection should be monitored or not
Definition: ConnectionProvider.qm.dox.h:246
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:258
ConnectionProvider::ConnectionInfo::children_can_support_messages
bool children_can_support_messages
if the data provider or any of its children support messages
Definition: ConnectionProvider.qm.dox.h:302
ConnectionProvider::ConnectionInfo::locked
bool locked
a boolean value indicating whether the connection is locked or not
Definition: ConnectionProvider.qm.dox.h:279
ConnectionProvider::ConnectionInfo::name
string name
the connection name
Definition: ConnectionProvider.qm.dox.h:234
ConnectionProvider::ConnectionInfo::type
string type
the connection type
Definition: ConnectionProvider.qm.dox.h:255
ConnectionProvider::ConnectionInfo::updated
*date updated
the date/time value of the update (or NOTHING if not updated)
Definition: ConnectionProvider.qm.dox.h:261
ConnectionProvider::ConnectionInfo::enabled
bool enabled
a boolean value indicating if the connection should be enabled or not
Definition: ConnectionProvider.qm.dox.h:274
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:284
ConnectionProvider::ConnectionInfo::children_can_support_observers
bool children_can_support_observers
if the data provider or any of its children support events
Definition: ConnectionProvider.qm.dox.h:299
ConnectionProvider::ConnectionInfo::status
string status
a string giving the connection's status
Definition: ConnectionProvider.qm.dox.h:252
ConnectionProvider::ConnectionInfo::desc
string desc
the connection description
Definition: ConnectionProvider.qm.dox.h:237
ConnectionProvider::ConnectionInfo::url
string url
the URL for the connection including the password
Definition: ConnectionProvider.qm.dox.h:266
ConnectionProvider::ConnectionInfo::url_hash
hash url_hash
a hash of URL information as returned by parse_url()
Definition: ConnectionProvider.qm.dox.h:269
ConnectionProvider::PingInfo
ping response info
Definition: ConnectionProvider.qm.dox.h:318
ConnectionProvider::PingInfo::time
date time
a relative date/time value giving the elapsed time of the ping operation
Definition: ConnectionProvider.qm.dox.h:334
ConnectionProvider::PingInfo::desc
string desc
the description
Definition: ConnectionProvider.qm.dox.h:322
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:340
ConnectionProvider::PingInfo::ok
bool ok
a boolean value giving the result of the ping
Definition: ConnectionProvider.qm.dox.h:331
ConnectionProvider::PingInfo::opts
*hash opts
the options set on the connection
Definition: ConnectionProvider.qm.dox.h:325
ConnectionProvider::PingInfo::url
string url
a safe version of the URL (without passwords)
Definition: ConnectionProvider.qm.dox.h:328
ConnectionProvider::PingInfo::name
string name
the name of the connection
Definition: ConnectionProvider.qm.dox.h:319
ConnectionProvider::PingInfo::info
string info
a string giving the result of the ping ("OK" or an error message)
Definition: ConnectionProvider.qm.dox.h:337