210 *hash<ExceptionInfo>
ex;
292 *
hash priv_try_get_connections(
string mod);
abstract base class for connections
Definition: AbstractConnection.qc.dox.h:32
hash< auto > hash(object obj)
the ConnectionProvider namespace. All classes used in the ConnectionProvider module should be inside ...
Definition: AbstractConnection.qc.dox.h:26
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 as returned by AbstractConnection::getConfigHash()
Definition: ConnectionProvider.qm.dox.h:193
*hash opts
the options set on the connection
Definition: ConnectionProvider.qm.dox.h:197
string name
the name of the connection
Definition: ConnectionProvider.qm.dox.h:194
string desc
the description
Definition: ConnectionProvider.qm.dox.h:195
string url
the full URL (including any username & password)
Definition: ConnectionProvider.qm.dox.h:196
information that can be used to dynamically construct a connection object
Definition: ConnectionProvider.qm.dox.h:134
string class_name
the name of the constructor's class
Definition: ConnectionProvider.qm.dox.h:139
*string module
any module required to be loaded for the constructor call
Definition: ConnectionProvider.qm.dox.h:136
*string pre_processing
code to execute before construction to preprocess the constructor arguments
Definition: ConnectionProvider.qm.dox.h:168
*string post_processing
code to execute after construction
Definition: ConnectionProvider.qm.dox.h:155
*softlist< auto > args
the constructor arguments
Definition: ConnectionProvider.qm.dox.h:142
connection information hash as returned by AbstractConnection::getInfo()
Definition: ConnectionProvider.qm.dox.h:172
hash< auto > tags
user-defined key-value pairs associated with the connection
Definition: ConnectionProvider.qm.dox.h:188
bool loopback
a boolean vaue indicating if the connection is a loopback connection
Definition: ConnectionProvider.qm.dox.h:176
bool has_provider
if the connection supports the data provider API
Definition: ConnectionProvider.qm.dox.h:189
*date last_check
the date/time value of the last connection check (or NOTHING if not checked)
Definition: ConnectionProvider.qm.dox.h:175
*hash opts
the original options used to create the object
Definition: ConnectionProvider.qm.dox.h:178
bool monitor
a boolean vaue indicating if the connection should be monitored or not
Definition: ConnectionProvider.qm.dox.h:177
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
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
string name
the connection name
Definition: ConnectionProvider.qm.dox.h:173
string type
the connection type
Definition: ConnectionProvider.qm.dox.h:180
*date updated
the date/time value of the update (or NOTHING if not updated)
Definition: ConnectionProvider.qm.dox.h:182
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
bool debug_data
a boolean value indicating whether the connection should be subject to data debugging....
Definition: ConnectionProvider.qm.dox.h:187
string status
a string giving the connection's status
Definition: ConnectionProvider.qm.dox.h:179
string desc
the connection description
Definition: ConnectionProvider.qm.dox.h:174
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
hash url_hash
a hash of URL information as returned by parse_url()
Definition: ConnectionProvider.qm.dox.h:184
ping response info as returned by AbstractConnection::ping()
Definition: ConnectionProvider.qm.dox.h:201
date time
a relative date/time value giving the elapsed time of the ping operation
Definition: ConnectionProvider.qm.dox.h:207
string desc
the description
Definition: ConnectionProvider.qm.dox.h:203
*hash ping_info
an optional free-form hash giving additional info regarding ping operation or the remote system
Definition: ConnectionProvider.qm.dox.h:209
bool ok
a boolean value giving the result of the ping
Definition: ConnectionProvider.qm.dox.h:206
*hash< ExceptionInfo > ex
if an exception occured, all exception info will be returned here
Definition: ConnectionProvider.qm.dox.h:210
*hash opts
the options set on the connection
Definition: ConnectionProvider.qm.dox.h:204
string url
a safe version of the URL (without passwords)
Definition: ConnectionProvider.qm.dox.h:205
string name
the name of the connection
Definition: ConnectionProvider.qm.dox.h:202
string info
a string giving the result of the ping ("OK" or an error message)
Definition: ConnectionProvider.qm.dox.h:208