ConnectionProvider.qm.dox.h
// -*- mode: c++; indent-tabs-mode: nil -*-
/* ConnectionProvider.qm Copyright 2016 - 2019 Qore Technologies, s.r.o.
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
*/
// minimum required Qore module
namespace ConnectionProvider {
public struct ConnectionConstructorInfo {
*string module;
string class_name;
*softlist<auto> args;
*string post_processing;
*string pre_processing;
};
public struct ConnectionInfo {
string name;
string desc;
*date last_check;
bool loopback;
bool monitor;
*hash opts;
string status;
string type;
bool up = False;
*date updated;
string url;
hash url_hash;
bool enabled;
bool locked;
bool debug_data;
hash<auto> tags;
bool has_provider = False;
};
public struct ConfigInfo {
string name;
string desc;
string url;
*hash opts;
};
public struct PingInfo {
string name;
string desc;
*hash opts;
string url;
bool ok;
date time;
string info;
*hash ping_info;
*hash<ExceptionInfo> ex;
};
string get_connection_url(string str);
AbstractConnection get_connection(string conn);
*hash<string, AbstractConnection> get_connections(*bool verbose);
*hash<string, hash<ConnectionInfo>> get_connection_hash(*bool verbose);
}; // ConnectionProvider namespace
// private, non-exported namespace
namespace Priv {
*hash priv_try_get_connections(string mod);
ConnectionProvider::AbstractConnection priv_try_get_connection(string mod, string conn);
}; // Priv nsmrspace
ConnectionProvider
the ConnectionProvider namespace. All classes used in the ConnectionProvider module should be inside ...
Definition: AbstractConnection.qc.dox.h:27
ConnectionProvider::AbstractConnection
abstract base class for connections
Definition: AbstractConnection.qc.dox.h:31
ConnectionProvider::ConfigInfo
config informaton as returned by AbstractConnection::getConfigHash()
Definition: ConnectionProvider.qm.dox.h:189
ConnectionProvider::ConnectionConstructorInfo::class_name
string class_name
the name of the constructor's class
Definition: ConnectionProvider.qm.dox.h:135
ConnectionProvider::ConfigInfo::opts
*hash opts
the options set on the connection
Definition: ConnectionProvider.qm.dox.h:193
ConnectionProvider::PingInfo::info
string info
a string giving the result of the ping ("OK" or an error message)
Definition: ConnectionProvider.qm.dox.h:204
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:171
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:205
ConnectionProvider::ConnectionInfo
connection information hash as returned by AbstractConnection::getInfo()
Definition: ConnectionProvider.qm.dox.h:168
ConnectionProvider::PingInfo::url
string url
a safe version of the URL (without passwords)
Definition: ConnectionProvider.qm.dox.h:201
ConnectionProvider::ConnectionInfo::name
string name
the connection name
Definition: ConnectionProvider.qm.dox.h:169
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:177
ConnectionProvider::ConnectionInfo::locked
bool locked
a boolean value indicating whether the connection is locked or not. This flag does not affect anythin...
Definition: ConnectionProvider.qm.dox.h:182
ConnectionProvider::ConnectionInfo::status
string status
a string giving the connection's status
Definition: ConnectionProvider.qm.dox.h:175
ConnectionProvider::ConfigInfo::name
string name
the name of the connection
Definition: ConnectionProvider.qm.dox.h:190
ConnectionProvider::PingInfo::ex
*hash< ExceptionInfo > ex
if an exception occured, all exception info will be returned here
Definition: ConnectionProvider.qm.dox.h:206
ConnectionProvider::ConnectionConstructorInfo::pre_processing
*string pre_processing
code to execute before construction to preprocess the constructor arguments
Definition: ConnectionProvider.qm.dox.h:164
ConnectionProvider::ConnectionInfo::updated
*date updated
the date/time value of the update (or NOTHING if not updated)
Definition: ConnectionProvider.qm.dox.h:178
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::ConfigInfo::url
string url
the full URL (including any username & password)
Definition: ConnectionProvider.qm.dox.h:192
ConnectionProvider::ConnectionConstructorInfo::args
*softlist< auto > args
the constructor arguments
Definition: ConnectionProvider.qm.dox.h:138
ConnectionProvider::PingInfo::desc
string desc
the description
Definition: ConnectionProvider.qm.dox.h:199
ConnectionProvider::ConnectionInfo::monitor
bool monitor
a boolean vaue indicating if the connection should be monitored or not
Definition: ConnectionProvider.qm.dox.h:173
ConnectionProvider::PingInfo::opts
*hash opts
the options set on the connection
Definition: ConnectionProvider.qm.dox.h:200
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:183
ConnectionProvider::ConnectionInfo::type
string type
the connection type
Definition: ConnectionProvider.qm.dox.h:176
ConnectionProvider::ConnectionInfo::opts
*hash opts
the original options used to create the object
Definition: ConnectionProvider.qm.dox.h:174
ConnectionProvider::PingInfo::ok
bool ok
a boolean value giving the result of the ping
Definition: ConnectionProvider.qm.dox.h:202
ConnectionProvider::ConfigInfo::desc
string desc
the description
Definition: ConnectionProvider.qm.dox.h:191
ConnectionProvider::ConnectionConstructorInfo
information that can be used to dynamically construct a connection object
Definition: ConnectionProvider.qm.dox.h:130
hash
hash< auto > hash(object obj)
ConnectionProvider::ConnectionInfo::enabled
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:181
ConnectionProvider::get_connection
AbstractConnection get_connection(string conn)
returns an AbstractConnection object if the identifier is known to a registered connection provider
ConnectionProvider::ConnectionConstructorInfo::post_processing
*string post_processing
code to execute after construction
Definition: ConnectionProvider.qm.dox.h:151
ConnectionProvider::PingInfo
ping response info as returned by AbstractConnection::ping()
Definition: ConnectionProvider.qm.dox.h:197
ConnectionProvider::ConnectionInfo::url_hash
hash url_hash
a hash of URL information as returned by parse_url()
Definition: ConnectionProvider.qm.dox.h:180
ConnectionProvider::ConnectionInfo::loopback
bool loopback
a boolean vaue indicating if the connection is a loopback connection
Definition: ConnectionProvider.qm.dox.h:172
ConnectionProvider::ConnectionInfo::url
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:179
False
const False
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::ConnectionConstructorInfo::module
*string module
any module required to be loaded for the constructor call
Definition: ConnectionProvider.qm.dox.h:132
ConnectionProvider::ConnectionInfo::tags
hash< auto > tags
user-defined key-value pairs associated with the connection
Definition: ConnectionProvider.qm.dox.h:184
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...
date
date date(date dt)
ConnectionProvider::PingInfo::name
string name
the name of the connection
Definition: ConnectionProvider.qm.dox.h:198
ConnectionProvider::ConnectionInfo::has_provider
bool has_provider
if the connection supports the data provider API
Definition: ConnectionProvider.qm.dox.h:185
ConnectionProvider::ConnectionInfo::desc
string desc
the connection description
Definition: ConnectionProvider.qm.dox.h:170
ConnectionProvider::PingInfo::time
date time
a relative date/time value giving the elapsed time of the ping operation
Definition: ConnectionProvider.qm.dox.h:203