512 *hash<ExceptionInfo>
ex;
594*hash priv_try_get_connections(
string mod);
Abstract base class for connections.
Definition AbstractConnection.qc.dox.h:47
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...
AbstractConnection get_connection(string conn)
returns an AbstractConnection object if the identifier is known to a registered connection provider
*hash< string, hash< ConnectionInfo > > get_connection_hash(*bool verbose)
returns a hash of connection information keyed by connection identifier; values are ConnectionInfo ha...
config informaton
Definition ConnectionProvider.qm.dox.h:473
*hash opts
the options set on the connection
Definition ConnectionProvider.qm.dox.h:477
string name
the name of the connection
Definition ConnectionProvider.qm.dox.h:474
string desc
the description
Definition ConnectionProvider.qm.dox.h:475
string url
the full URL (including any username & password)
Definition ConnectionProvider.qm.dox.h:476
information that can be used to dynamically construct a connection object
Definition ConnectionProvider.qm.dox.h:239
*string string class_name
any module required to be loaded for the constructor call
Definition ConnectionProvider.qm.dox.h:244
*string pre_processing
code to execute before construction to preprocess the constructor arguments
Definition ConnectionProvider.qm.dox.h:273
*string post_processing
code to execute after construction
Definition ConnectionProvider.qm.dox.h:260
*softlist< auto > args
the constructor arguments
Definition ConnectionProvider.qm.dox.h:247
Connection information hash containing only serializable data.
Definition ConnectionProvider.qm.dox.h:377
string url
the URL for the connection including the password
Definition ConnectionProvider.qm.dox.h:417
string status
a string giving the connection's status
Definition ConnectionProvider.qm.dox.h:403
string short_desc
the connection short description in plain text
Definition ConnectionProvider.qm.dox.h:385
bool locked
a boolean value indicating whether the connection is locked or not
Definition ConnectionProvider.qm.dox.h:430
string type
the connection type
Definition ConnectionProvider.qm.dox.h:406
bool children_can_support_apis
if the data provider or any of its children support requests (APIs)
Definition ConnectionProvider.qm.dox.h:455
*date last_check
the date/time value of the last connection check (or NOTHING if not checked)
Definition ConnectionProvider.qm.dox.h:391
bool up
a boolean vaue indicating the connection is known to be up (will be False if not checked)
Definition ConnectionProvider.qm.dox.h:409
bool children_can_support_records
if the data provider or any of its children support records
Definition ConnectionProvider.qm.dox.h:458
*date updated
the date/time value of the update (or NOTHING if not updated)
Definition ConnectionProvider.qm.dox.h:412
bool children_can_support_observers
if the data provider or any of its children support events
Definition ConnectionProvider.qm.dox.h:461
bool debug_data
a boolean value indicating whether the connection should be subject to data debugging
Definition ConnectionProvider.qm.dox.h:435
string name
the connection name
Definition ConnectionProvider.qm.dox.h:379
*hash opts
the original options used to create the object
Definition ConnectionProvider.qm.dox.h:400
string desc
the connection description
Definition ConnectionProvider.qm.dox.h:388
*hash< string, *hash< string, hash< auto > > > dataprovider_subtypes
Data provider subtype information.
Definition ConnectionProvider.qm.dox.h:444
*hash< string, bool > features
connection-defined feature hash
Definition ConnectionProvider.qm.dox.h:441
bool monitor
a boolean vaue indicating if the connection should be monitored or not
Definition ConnectionProvider.qm.dox.h:397
hash url_hash
a hash of URL information as returned by parse_url()
Definition ConnectionProvider.qm.dox.h:420
bool children_can_support_transactions
if the data provider or any of its children support transaction management
Definition ConnectionProvider.qm.dox.h:467
bool has_provider
if the connection supports the data provider API
Definition ConnectionProvider.qm.dox.h:452
bool loopback
a boolean vaue indicating if the connection is a loopback connection
Definition ConnectionProvider.qm.dox.h:394
bool enabled
a boolean value indicating if the connection should be enabled or not
Definition ConnectionProvider.qm.dox.h:425
bool children_can_support_messages
if the data provider or any of its children support messages
Definition ConnectionProvider.qm.dox.h:464
hash< auto > tags
user-defined key-value pairs associated with the connection
Definition ConnectionProvider.qm.dox.h:438
string display_name
the display name
Definition ConnectionProvider.qm.dox.h:382
bool needs_auth
True if the connection requires OAuth2 authorization before it can be used
Definition ConnectionProvider.qm.dox.h:449
Connection information hash.
Definition ConnectionProvider.qm.dox.h:279
hash< auto > tags
user-defined key-value pairs associated with the connection
Definition ConnectionProvider.qm.dox.h:340
bool children_can_support_records
if the data provider or any of its children support records
Definition ConnectionProvider.qm.dox.h:360
bool loopback
a boolean vaue indicating if the connection is a loopback connection
Definition ConnectionProvider.qm.dox.h:296
bool has_provider
if the connection supports the data provider API
Definition ConnectionProvider.qm.dox.h:354
*date last_check
the date/time value of the last connection check (or NOTHING if not checked)
Definition ConnectionProvider.qm.dox.h:293
*hash opts
the original options used to create the object
Definition ConnectionProvider.qm.dox.h:302
string short_desc
the connection short description in plain text
Definition ConnectionProvider.qm.dox.h:287
bool children_can_support_apis
if the data provider or any of its children support requests (APIs)
Definition ConnectionProvider.qm.dox.h:357
bool monitor
a boolean vaue indicating if the connection should be monitored or not
Definition ConnectionProvider.qm.dox.h:299
bool up
a boolean vaue indicating the connection is known to be up (will be False if not checked)
Definition ConnectionProvider.qm.dox.h:311
bool children_can_support_messages
if the data provider or any of its children support messages
Definition ConnectionProvider.qm.dox.h:366
bool locked
a boolean value indicating whether the connection is locked or not
Definition ConnectionProvider.qm.dox.h:332
*hash< string, bool > features
connection-defined feature hash
Definition ConnectionProvider.qm.dox.h:343
string name
the connection name
Definition ConnectionProvider.qm.dox.h:281
bool children_can_support_transactions
if the data provider or any of its children support transaction management
Definition ConnectionProvider.qm.dox.h:369
string type
the connection type
Definition ConnectionProvider.qm.dox.h:308
bool needs_auth
True if the connection requires OAuth2 authorization before it can be used
Definition ConnectionProvider.qm.dox.h:351
*date updated
the date/time value of the update (or NOTHING if not updated)
Definition ConnectionProvider.qm.dox.h:314
bool enabled
a boolean value indicating if the connection should be enabled or not
Definition ConnectionProvider.qm.dox.h:327
*hash< string, *hash< string, hash< DataProviderOptionInfo > > > dataprovider_subtypes
Data provider subtype information.
Definition ConnectionProvider.qm.dox.h:346
bool debug_data
a boolean value indicating whether the connection should be subject to data debugging
Definition ConnectionProvider.qm.dox.h:337
bool children_can_support_observers
if the data provider or any of its children support events
Definition ConnectionProvider.qm.dox.h:363
string display_name
the display name
Definition ConnectionProvider.qm.dox.h:284
string status
a string giving the connection's status
Definition ConnectionProvider.qm.dox.h:305
string desc
the connection description in markdown
Definition ConnectionProvider.qm.dox.h:290
string url
the URL for the connection including the password
Definition ConnectionProvider.qm.dox.h:319
hash url_hash
a hash of URL information as returned by parse_url()
Definition ConnectionProvider.qm.dox.h:322
ping response info
Definition ConnectionProvider.qm.dox.h:483
date time
a relative date/time value giving the elapsed time of the ping operation
Definition ConnectionProvider.qm.dox.h:500
string desc
the description
Definition ConnectionProvider.qm.dox.h:488
*hash ping_info
an optional free-form hash giving additional info regarding ping operation or the remote system
Definition ConnectionProvider.qm.dox.h:509
bool ok
a boolean value giving the result of the ping
Definition ConnectionProvider.qm.dox.h:497
*hash< ExceptionInfo > ex
if an exception occured, all exception info will be returned here
Definition ConnectionProvider.qm.dox.h:512
*hash opts
the options set on the connection
Definition ConnectionProvider.qm.dox.h:491
string url
a safe version of the URL (without passwords)
Definition ConnectionProvider.qm.dox.h:494
string name
the name of the connection
Definition ConnectionProvider.qm.dox.h:485
int ping_flags
Ping flags used for the ping.
Definition ConnectionProvider.qm.dox.h:506
string info
a string giving the result of the ping ("OK" or an error message)
Definition ConnectionProvider.qm.dox.h:503