96 constructor(
string n_name,
string n_desc,
string n_url,
bool n_monitor, *
hash n_opts,
hash n_urlh, *
string n_safe_url, *
bool n_enabled);
116 constructor(
string name,
string description,
string url, hash<auto> attributes = {}, hash<auto> options = {});
120 constructorInit(
string name,
string description,
string url, hash<auto> attributes, hash<auto> options);
172 hash<PingInfo>
ping(
bool throw_exception =
False);
186 hash<ConnectionInfo>
getInfo(
bool with_password =
False);
parseTextOptions()
this method is called when parsing connection file definitions from text files when loading into the ...
auto getTag(string tag)
returns the value of the given tag or NOTHING if not present
*hash getRuntimeOptions()
returns runtime options
bool monitor
monitoring flag
Definition: AbstractConnection.qc.dox.h:65
date last_check
date/time of last check/ping
Definition: AbstractConnection.qc.dox.h:56
bool locked
locked/unlocked flag
Definition: AbstractConnection.qc.dox.h:80
hash< ConnectionInfo > getInfo(bool with_password=False)
returns a ConnectionInfo hash of information about the connection
string getSafeUrl(hash< auto > urlh)
creates a "safe" URL string with password information removed
abstract hash< ConnectionConstructorInfo > getConstructorInfoImpl()
this method must return a ConnectionConstructorInfo hash for creating the connection object dynamical...
abstract object getImpl(bool connect=True, *hash rtopts)
this method must return the connection object corresponding to the object's configuration
*hash opts
connection options
Definition: AbstractConnection.qc.dox.h:50
hash< ConnectionConstructorInfo > getConstructorInfo()
returns a ConnectionConstructorInfo hash for creating the connection object dynamically
deprecated constructor(string n_name, string n_desc, string n_url, bool n_monitor, *hash n_opts, hash n_urlh, *string n_safe_url, *bool n_enabled)
creates the AbstractConnection object
string name
connection name
Definition: AbstractConnection.qc.dox.h:35
*hash getDefaultOptions()
returns default options
hash urlh
broken down URL hash (as returned by Qore::parse_url())
Definition: AbstractConnection.qc.dox.h:53
static *code post_processing
optional code for default post-processing of objects created by getImpl(); must take the object creat...
Definition: AbstractConnection.qc.dox.h:74
hash< PingInfo > ping(bool throw_exception=False)
returns a hash with the results of the ping operation
string status
status string; in case of a connection error this string will be the error string
Definition: AbstractConnection.qc.dox.h:59
*hash orig_opts
original connection options
Definition: AbstractConnection.qc.dox.h:47
hash< auto > tags
connection tags; user-defined key-value pairs
Definition: AbstractConnection.qc.dox.h:83
abstract base class for connections
Definition: AbstractConnection.qc.dox.h:31
*hash getOptions()
returns static / initialization options
string safe_url
"safe" URL (password information removed)
Definition: AbstractConnection.qc.dox.h:44
bool enabled
enabled/disabled indicator flag
Definition: AbstractConnection.qc.dox.h:77
auto getTagEx(string tag)
returns the value of the given tag or throws an exception if the tag is not set with a value
abstract string getType()
returns the string type name for the connection object
object get(bool connect=True, *hash rtopts)
returns the underlying connection object
*hash getRealOptions()
returns options for saving the connection's configuration information
hash< ConfigInfo > getConfigHash()
returns a ConfigInfo hash of static configuration information about the connection
hash< auto > getTags()
returns all tags associated with the connection
string desc
connection description
Definition: AbstractConnection.qc.dox.h:38
hash< auto > hash(object obj)
date updated
date/time of last update
Definition: AbstractConnection.qc.dox.h:68
hash< auto > validateOptions(hash< auto > options)
performs options validation in the constructor
hash< UrlInfo > parseUrl(string url)
Parse the URL to a hash.
bool up
connection status flag; set by monitoring or explicit pings/connections
Definition: AbstractConnection.qc.dox.h:62
string url
connection URL (potentially with password info)
Definition: AbstractConnection.qc.dox.h:41
hash< PingInfo > pingIntern(hash< PingInfo > rv)
performs the ping by executing get(); returns a PingInfo hash
bool loopback
set to True for loopback connections
Definition: AbstractConnection.qc.dox.h:71
the ConnectionProvider namespace. All classes used in the ConnectionProvider module should be inside ...
Definition: AbstractConnection.qc.dox.h:27