$darkmode
Qore ConnectionProvider Module Reference 1.11
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 
223 
225 namespace ConnectionProvider {
227 
233  *string module;
234 
236  string class_name;
237 
239  *softlist<auto> args;
240 
242 
253 
255 
265  *string pre_processing;
266 };
267 
269 
271 public struct ConnectionInfo {
273  string name;
274 
276  string desc;
277 
280 
282  bool loopback;
283 
285  bool monitor;
286 
289 
291  string status;
292 
294  string type;
295 
297  bool up = False;
298 
301 
303 
305  string url;
306 
309 
311 
313  bool enabled;
314 
316 
318  bool locked;
319 
321 
324 
326  hash<auto> tags;
327 
329  *hash<string, bool> features;
330 
333 
336 
339 
342 
345 
348 };
349 
351 
353 public struct ConfigInfo {
354  string name;
355  string desc;
356  string url;
358 };
359 
361 
363 public struct PingInfo {
364  string name;
366 
367  string desc;
369 
372 
373  string url;
375 
376  bool ok;
378 
381 
382  string info;
384 
387 
389  *hash<ExceptionInfo> ex;
390 };
391 
393 
408  string get_connection_url(string str);
409 
410 
412 
428 
429 
431 
446  *hash<string, AbstractConnection> get_connections(*bool verbose);
447 
448 
450 
465  *hash<string, hash<ConnectionInfo>> get_connection_hash(*bool verbose);
466 
467 }; // ConnectionProvider namespace
468 
469 // private, non-exported namespace
470 namespace Priv {
471 *hash priv_try_get_connections(string mod);
472 
473 
474 ConnectionProvider::AbstractConnection priv_try_get_connection(string mod, string conn);
475 
476 }; // Priv nsmrspace
abstract base class for connections
Definition: AbstractConnection.qc.dox.h:34
const False
date date(date dt)
hash< auto > hash(object obj)
The ConnectionProvider namespace.
Definition: AbstractConnection.qc.dox.h:28
string get_connection_url(string str)
returns a URL string for the given identifier if the identifier is known to a registered connection p...
*hash< string, AbstractConnection > get_connections(*bool verbose)
returns all known connections as a hash keyed by connection identifier; values are AbstractConnection...
*hash< string, hash< ConnectionInfo > > get_connection_hash(*bool verbose)
returns a hash of connection information keyed by connection identifier; values are ConnectionInfo ha...
AbstractConnection get_connection(string conn)
returns an AbstractConnection object if the identifier is known to a registered connection provider
config informaton
Definition: ConnectionProvider.qm.dox.h:353
*hash opts
the options set on the connection
Definition: ConnectionProvider.qm.dox.h:357
string name
the name of the connection
Definition: ConnectionProvider.qm.dox.h:354
string desc
the description
Definition: ConnectionProvider.qm.dox.h:355
string url
the full URL (including any username & password)
Definition: ConnectionProvider.qm.dox.h:356
information that can be used to dynamically construct a connection object
Definition: ConnectionProvider.qm.dox.h:231
string class_name
the name of the constructor's class
Definition: ConnectionProvider.qm.dox.h:236
*string module
any module required to be loaded for the constructor call
Definition: ConnectionProvider.qm.dox.h:233
*string pre_processing
code to execute before construction to preprocess the constructor arguments
Definition: ConnectionProvider.qm.dox.h:265
*string post_processing
code to execute after construction
Definition: ConnectionProvider.qm.dox.h:252
*softlist< auto > args
the constructor arguments
Definition: ConnectionProvider.qm.dox.h:239
connection information hash
Definition: ConnectionProvider.qm.dox.h:271
hash< auto > tags
user-defined key-value pairs associated with the connection
Definition: ConnectionProvider.qm.dox.h:326
bool children_can_support_records
if the data provider or any of its children support records
Definition: ConnectionProvider.qm.dox.h:338
bool loopback
a boolean vaue indicating if the connection is a loopback connection
Definition: ConnectionProvider.qm.dox.h:282
bool has_provider
if the connection supports the data provider API
Definition: ConnectionProvider.qm.dox.h:332
*date last_check
the date/time value of the last connection check (or NOTHING if not checked)
Definition: ConnectionProvider.qm.dox.h:279
*hash opts
the original options used to create the object
Definition: ConnectionProvider.qm.dox.h:288
bool children_can_support_apis
if the data provider or any of its children support requests (APIs)
Definition: ConnectionProvider.qm.dox.h:335
bool monitor
a boolean vaue indicating if the connection should be monitored or not
Definition: ConnectionProvider.qm.dox.h:285
bool up
a boolean vaue indicating the connection is known to be up (will be False if not checked)
Definition: ConnectionProvider.qm.dox.h:297
bool children_can_support_messages
if the data provider or any of its children support messages
Definition: ConnectionProvider.qm.dox.h:344
bool locked
a boolean value indicating whether the connection is locked or not
Definition: ConnectionProvider.qm.dox.h:318
*hash< string, bool > features
connection-defined feature hash
Definition: ConnectionProvider.qm.dox.h:329
string name
the connection name
Definition: ConnectionProvider.qm.dox.h:273
bool children_can_support_transactions
if the data provider or any of its children support transaction management
Definition: ConnectionProvider.qm.dox.h:347
string type
the connection type
Definition: ConnectionProvider.qm.dox.h:294
*date updated
the date/time value of the update (or NOTHING if not updated)
Definition: ConnectionProvider.qm.dox.h:300
bool enabled
a boolean value indicating if the connection should be enabled or not
Definition: ConnectionProvider.qm.dox.h:313
bool debug_data
a boolean value indicating whether the connection should be subject to data debugging
Definition: ConnectionProvider.qm.dox.h:323
bool children_can_support_observers
if the data provider or any of its children support events
Definition: ConnectionProvider.qm.dox.h:341
string status
a string giving the connection's status
Definition: ConnectionProvider.qm.dox.h:291
string desc
the connection description
Definition: ConnectionProvider.qm.dox.h:276
string url
the URL for the connection including the password
Definition: ConnectionProvider.qm.dox.h:305
hash url_hash
a hash of URL information as returned by parse_url()
Definition: ConnectionProvider.qm.dox.h:308
ping response info
Definition: ConnectionProvider.qm.dox.h:363
date time
a relative date/time value giving the elapsed time of the ping operation
Definition: ConnectionProvider.qm.dox.h:379
string desc
the description
Definition: ConnectionProvider.qm.dox.h:367
*hash ping_info
an optional free-form hash giving additional info regarding ping operation or the remote system
Definition: ConnectionProvider.qm.dox.h:385
bool ok
a boolean value giving the result of the ping
Definition: ConnectionProvider.qm.dox.h:376
*hash opts
the options set on the connection
Definition: ConnectionProvider.qm.dox.h:370
string url
a safe version of the URL (without passwords)
Definition: ConnectionProvider.qm.dox.h:373
string name
the name of the connection
Definition: ConnectionProvider.qm.dox.h:364
string info
a string giving the result of the ping ("OK" or an error message)
Definition: ConnectionProvider.qm.dox.h:382