Loading...
Searching...
No Matches
AbstractConnection.qc.dox.h
// -*- mode: c++; indent-tabs-mode: nil -*-
// Qore AbstractConnection class definition
/* AbstractConnection.qc Copyright 2016 - 2023 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.
*/
namespace ConnectionProvider {
class AbstractConnection : public Qore::Serializable {
public:
string name;
string desc;
string url;
string safe_url;
*hash<auto> orig_opts;
*hash<auto> opts;
hash<auto> urlh;
date last_check;
string status = "not checked";
bool up = False;
bool monitor;
date updated;
bool loopback = False;
static *code post_processing;
bool enabled = True;
bool locked = False;
bool debug_data = False;
hash<auto> tags = {};
bool children_can_support_apis = False;
bool children_can_support_records = False;
bool children_can_support_observers = False;
bool children_can_support_messages = False;
bool children_can_support_transactions = False;
hash<auto> internal_info;
deprecated
constructor(string name,
string desc,
string url,
bool monitor,
*hash opts,
hash urlh,
*string safe_url,
*bool enabled) {
// remove "enabled" option from option hash, if any
*bool opt_enabled = remove opts.enabled;
hash<auto> attributes = {
"monitor": monitor,
"enabled": enabled ?? opt_enabled ?? True,
};
constructorInit(name, desc, url, attributes, opts ?? {});
}
constructor(string name, string description, string url, hash<auto> attributes = {}, hash<auto> options = {});
string getName();
string getDescription();
string getUrl();
string getSafeUrl();
hash<PingInfo> ping(bool throw_exception = False);
protected:
hash<PingInfo> pingIntern(hash<PingInfo> rv);
public:
hash<ConnectionInfo> getInfo(bool with_password = False);
hash<ConnectionInfo> getInfo(*hash<auto> opts);
hash<auto> getExtendedInfo(*hash<auto> opts);
hash<ConfigInfo> getConfigHash();
hash<ConnectionSchemeInfo> getConnectionSchemeInfo();
*hash<auto> getOptions();
*hash<auto> getRuntimeOptions();
*hash<auto> getDefaultOptions();
*hash<auto> getRealOptions();
object get(bool connect = True, *hash<auto> rtopts);
parseTextOptions();
hash<auto> getTags();
auto getTag(string tag);
auto getTagEx(string tag);
AbstractDataProvider getDataProvider();
bool hasDataProvider();
bool supportsPollingApi();
Qore::AbstractPollOperation startPollConnect();
object getPollImpl();
handlePingSuccess(date delta);
handlePingFailed(date delta, hash<ExceptionInfo> ex);
handlePingFailed(date delta, string err);
protected:
pingImpl();
public:
protected:
hash<UrlInfo> parseUrl(string url);
public:
protected:
string getSafeUrl(hash<auto> urlh);
public:
protected:
hash<auto> validateOptions(hash<auto> options);
public:
private:
constructorInit(string name, string description, string url, hash<auto> attributes, hash<auto> options);
public:
protected:
setChildCapabilities();
public:
abstract string getType();
protected:
abstract object getImpl(bool connect = True, *hash<auto> rtopts);
public:
};
}; // ConnectionProvider namespace
ConnectionProvider::AbstractConnection
abstract base class for connections
Definition: AbstractConnection.qc.dox.h:34
ConnectionProvider::AbstractConnection::desc
string desc
connection description
Definition: AbstractConnection.qc.dox.h:41
ConnectionProvider::AbstractConnection::locked
bool locked
locked/unlocked flag
Definition: AbstractConnection.qc.dox.h:83
ConnectionProvider::AbstractConnection::getName
string getName()
Returns the connection name.
ConnectionProvider::AbstractConnection::pingImpl
pingImpl()
performs the internal ping
ConnectionProvider::AbstractConnection::getInfo
hash< ConnectionInfo > getInfo(*hash< auto > opts)
returns a ConnectionInfo hash of information about the connection
ConnectionProvider::AbstractConnection::getInfo
hash< ConnectionInfo > getInfo(bool with_password=False)
returns a ConnectionInfo hash of information about the connection
ConnectionProvider::AbstractConnection::hasDataProvider
bool hasDataProvider()
returns True if the connection returns a data provider with the getDataProvider() method
ConnectionProvider::AbstractConnection::children_can_support_transactions
bool children_can_support_transactions
if the data provider or any of its children support transaction management
Definition: AbstractConnection.qc.dox.h:104
ConnectionProvider::AbstractConnection::opts
*hash< auto > opts
connection options
Definition: AbstractConnection.qc.dox.h:53
ConnectionProvider::AbstractConnection::getPollImpl
object getPollImpl()
Returns an unconnected object for a non-blocking poll operation.
ConnectionProvider::AbstractConnection::get
object get(bool connect=True, *hash< auto > rtopts)
returns the underlying connection object
ConnectionProvider::AbstractConnection::getTagEx
auto getTagEx(string tag)
returns the value of the given tag or throws an exception if the tag is not set with a value
ConnectionProvider::AbstractConnection::internal_info
hash< auto > internal_info
internal tags
Definition: AbstractConnection.qc.dox.h:107
ConnectionProvider::AbstractConnection::orig_opts
*hash< auto > orig_opts
original connection options
Definition: AbstractConnection.qc.dox.h:50
ConnectionProvider::AbstractConnection::getRuntimeOptions
*hash< auto > getRuntimeOptions()
returns runtime options
ConnectionProvider::AbstractConnection::url
string url
connection URL (potentially with password info)
Definition: AbstractConnection.qc.dox.h:44
ConnectionProvider::AbstractConnection::children_can_support_messages
bool children_can_support_messages
if the data provider or any of its children support messages
Definition: AbstractConnection.qc.dox.h:101
ConnectionProvider::AbstractConnection::getExtendedInfo
hash< auto > getExtendedInfo(*hash< auto > opts)
Returns connection info plus any extended information returned by the connection.
ConnectionProvider::AbstractConnection::monitor
bool monitor
monitoring flag
Definition: AbstractConnection.qc.dox.h:68
ConnectionProvider::AbstractConnection::safe_url
string safe_url
"safe" URL (password information removed)
Definition: AbstractConnection.qc.dox.h:47
ConnectionProvider::AbstractConnection::setChildCapabilities
setChildCapabilities()
Override to set child data provider capabilities once per child class.
ConnectionProvider::AbstractConnection::startPollConnect
Qore::AbstractPollOperation startPollConnect()
Called to start the connection polling operation.
ConnectionProvider::AbstractConnection::tags
hash< auto > tags
connection tags; user-defined key-value pairs
Definition: AbstractConnection.qc.dox.h:89
ConnectionProvider::AbstractConnection::getSafeUrl
string getSafeUrl(hash< auto > urlh)
creates a "safe" URL string with password information removed
ConnectionProvider::AbstractConnection::enabled
bool enabled
enabled/disabled indicator flag
Definition: AbstractConnection.qc.dox.h:80
ConnectionProvider::AbstractConnection::getDataProvider
AbstractDataProvider getDataProvider()
returns a data provider object for this connection, if supported
ConnectionProvider::AbstractConnection::last_check
date last_check
date/time of last check/ping
Definition: AbstractConnection.qc.dox.h:59
ConnectionProvider::AbstractConnection::up
bool up
connection status flag; set by monitoring or explicit pings/connections
Definition: AbstractConnection.qc.dox.h:65
ConnectionProvider::AbstractConnection::validateOptions
hash< auto > validateOptions(hash< auto > options)
performs options validation in the constructor
ConnectionProvider::AbstractConnection::getDescription
string getDescription()
Returns the connection description.
ConnectionProvider::AbstractConnection::getConnectionSchemeInfo
hash< ConnectionSchemeInfo > getConnectionSchemeInfo()
Returns a default ConnectionSchemeInfo hash.
ConnectionProvider::AbstractConnection::pingIntern
hash< PingInfo > pingIntern(hash< PingInfo > rv)
performs the ping by executing get(); returns a PingInfo hash
ConnectionProvider::AbstractConnection::supportsPollingApi
bool supportsPollingApi()
returns True if the connection supports the Qore Socket-based polling API
ConnectionProvider::AbstractConnection::debug_data
bool debug_data
debug data flag; to be used an an indication for a higher-level implementation
Definition: AbstractConnection.qc.dox.h:86
ConnectionProvider::AbstractConnection::constructorInit
constructorInit(string name, string description, string url, hash< auto > attributes, hash< auto > options)
Common construtor implementation.
ConnectionProvider::AbstractConnection::name
string name
connection name
Definition: AbstractConnection.qc.dox.h:38
ConnectionProvider::AbstractConnection::parseUrl
hash< UrlInfo > parseUrl(string url)
Parse the URL to a hash.
ConnectionProvider::AbstractConnection::getConfigHash
hash< ConfigInfo > getConfigHash()
returns a ConfigInfo hash of static configuration information about the connection
ConnectionProvider::AbstractConnection::getOptions
*hash< auto > getOptions()
returns static / initialization options
ConnectionProvider::AbstractConnection::getTags
hash< auto > getTags()
returns all tags associated with the connection
ConnectionProvider::AbstractConnection::getImpl
abstract object getImpl(bool connect=True, *hash< auto > rtopts)
this method must return the connection object corresponding to the object's configuration
ConnectionProvider::AbstractConnection::constructor
deprecated constructor(string name, string desc, string url, bool monitor, *hash opts, hash urlh, *string safe_url, *bool enabled)
creates the AbstractConnection object
Definition: AbstractConnection.qc.dox.h:120
ConnectionProvider::AbstractConnection::handlePingFailed
handlePingFailed(date delta, hash< ExceptionInfo > ex)
Handles a failed ping operation on the connection.
ConnectionProvider::AbstractConnection::getSafeUrl
string getSafeUrl()
Returns the connection safe URL (without password info)
ConnectionProvider::AbstractConnection::getUrl
string getUrl()
Returns the connection URL.
ConnectionProvider::AbstractConnection::getDefaultOptions
*hash< auto > getDefaultOptions()
returns default options
ConnectionProvider::AbstractConnection::constructor
constructor(string name, string description, string url, hash< auto > attributes={}, hash< auto > options={})
creates the AbstractConnection object
ConnectionProvider::AbstractConnection::getTag
auto getTag(string tag)
returns the value of the given tag or NOTHING if not present
ConnectionProvider::AbstractConnection::status
string status
status string; in case of a connection error this string will be the error string
Definition: AbstractConnection.qc.dox.h:62
ConnectionProvider::AbstractConnection::parseTextOptions
parseTextOptions()
this method is called when parsing connection file definitions from text files when loading into the ...
ConnectionProvider::AbstractConnection::updated
date updated
date/time of last update
Definition: AbstractConnection.qc.dox.h:71
ConnectionProvider::AbstractConnection::children_can_support_apis
bool children_can_support_apis
if the data provider or any of its children support requests (APIs)
Definition: AbstractConnection.qc.dox.h:92
ConnectionProvider::AbstractConnection::post_processing
static *code post_processing
optional code for default post-processing of objects created by getImpl(); must take the connection o...
Definition: AbstractConnection.qc.dox.h:77
ConnectionProvider::AbstractConnection::loopback
bool loopback
set to True for loopback connections
Definition: AbstractConnection.qc.dox.h:74
ConnectionProvider::AbstractConnection::children_can_support_observers
bool children_can_support_observers
if the data provider or any of its children support events
Definition: AbstractConnection.qc.dox.h:98
ConnectionProvider::AbstractConnection::children_can_support_records
bool children_can_support_records
if the data provider or any of its children support records
Definition: AbstractConnection.qc.dox.h:95
ConnectionProvider::AbstractConnection::getType
abstract string getType()
returns the string type name for the connection object
ConnectionProvider::AbstractConnection::handlePingFailed
handlePingFailed(date delta, string err)
Handles a failed ping operation on the connection.
ConnectionProvider::AbstractConnection::urlh
hash< auto > urlh
broken down URL hash (as returned by Qore::parse_url())
Definition: AbstractConnection.qc.dox.h:56
ConnectionProvider::AbstractConnection::ping
hash< PingInfo > ping(bool throw_exception=False)
returns a hash with the results of the ping operation
ConnectionProvider::AbstractConnection::getRealOptions
*hash< auto > getRealOptions()
returns options for saving the connection's configuration information
ConnectionProvider::AbstractConnection::handlePingSuccess
handlePingSuccess(date delta)
Handles a successful ping operation on the connection.
Qore::AbstractPollOperation
Qore::Serializable
ConnectionProvider
The ConnectionProvider namespace.
Definition: AbstractConnection.qc.dox.h:28