327 *hash<ExceptionInfo> ex;
409*hash priv_try_get_connections(
string mod);
abstract base class for connections
Definition: AbstractConnection.qc.dox.h:34
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:291
*hash opts
the options set on the connection
Definition: ConnectionProvider.qm.dox.h:295
string name
the name of the connection
Definition: ConnectionProvider.qm.dox.h:292
string desc
the description
Definition: ConnectionProvider.qm.dox.h:293
string url
the full URL (including any username & password)
Definition: ConnectionProvider.qm.dox.h:294
information that can be used to dynamically construct a connection object
Definition: ConnectionProvider.qm.dox.h:175
string class_name
the name of the constructor's class
Definition: ConnectionProvider.qm.dox.h:180
*string module
any module required to be loaded for the constructor call
Definition: ConnectionProvider.qm.dox.h:177
*string pre_processing
code to execute before construction to preprocess the constructor arguments
Definition: ConnectionProvider.qm.dox.h:209
*string post_processing
code to execute after construction
Definition: ConnectionProvider.qm.dox.h:196
*softlist< auto > args
the constructor arguments
Definition: ConnectionProvider.qm.dox.h:183
connection information hash
Definition: ConnectionProvider.qm.dox.h:215
hash< auto > tags
user-defined key-value pairs associated with the connection
Definition: ConnectionProvider.qm.dox.h:270
bool children_can_support_records
if the data provider or any of its children support records
Definition: ConnectionProvider.qm.dox.h:279
bool loopback
a boolean vaue indicating if the connection is a loopback connection
Definition: ConnectionProvider.qm.dox.h:226
bool has_provider
if the connection supports the data provider API
Definition: ConnectionProvider.qm.dox.h:273
*date last_check
the date/time value of the last connection check (or NOTHING if not checked)
Definition: ConnectionProvider.qm.dox.h:223
*hash opts
the original options used to create the object
Definition: ConnectionProvider.qm.dox.h:232
bool children_can_support_apis
if the data provider or any of its children support requests (APIs)
Definition: ConnectionProvider.qm.dox.h:276
bool monitor
a boolean vaue indicating if the connection should be monitored or not
Definition: ConnectionProvider.qm.dox.h:229
bool up
a boolean vaue indicating the connection is known to be up (will be False if not checked)
Definition: ConnectionProvider.qm.dox.h:241
bool children_can_support_messages
if the data provider or any of its children support messages
Definition: ConnectionProvider.qm.dox.h:285
bool locked
a boolean value indicating whether the connection is locked or not
Definition: ConnectionProvider.qm.dox.h:262
string name
the connection name
Definition: ConnectionProvider.qm.dox.h:217
string type
the connection type
Definition: ConnectionProvider.qm.dox.h:238
*date updated
the date/time value of the update (or NOTHING if not updated)
Definition: ConnectionProvider.qm.dox.h:244
bool enabled
a boolean value indicating if the connection should be enabled or not
Definition: ConnectionProvider.qm.dox.h:257
bool debug_data
a boolean value indicating whether the connection should be subject to data debugging
Definition: ConnectionProvider.qm.dox.h:267
bool children_can_support_observers
if the data provider or any of its children support events
Definition: ConnectionProvider.qm.dox.h:282
string status
a string giving the connection's status
Definition: ConnectionProvider.qm.dox.h:235
string desc
the connection description
Definition: ConnectionProvider.qm.dox.h:220
string url
the URL for the connection including the password
Definition: ConnectionProvider.qm.dox.h:249
hash url_hash
a hash of URL information as returned by parse_url()
Definition: ConnectionProvider.qm.dox.h:252
ping response info
Definition: ConnectionProvider.qm.dox.h:301
date time
a relative date/time value giving the elapsed time of the ping operation
Definition: ConnectionProvider.qm.dox.h:317
string desc
the description
Definition: ConnectionProvider.qm.dox.h:305
*hash ping_info
an optional free-form hash giving additional info regarding ping operation or the remote system
Definition: ConnectionProvider.qm.dox.h:323
bool ok
a boolean value giving the result of the ping
Definition: ConnectionProvider.qm.dox.h:314
*hash opts
the options set on the connection
Definition: ConnectionProvider.qm.dox.h:308
string url
a safe version of the URL (without passwords)
Definition: ConnectionProvider.qm.dox.h:311
string name
the name of the connection
Definition: ConnectionProvider.qm.dox.h:302
string info
a string giving the result of the ping ("OK" or an error message)
Definition: ConnectionProvider.qm.dox.h:320