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;
 
        transient hash<auto> transient_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<ConnectionSchemeInfo> getConnectionSchemeInfoImpl();
 
 
    *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:internal constructorInit(string name, string description, string url, hash<auto> attributes,
            hash<auto> options) {
        // metadata
        self.name = name;
        desc = description;
 
        // url handling
        self.url = url;
        urlh = parseUrl(self.url);
        safe_url = getSafeUrl(self.urlh);
 
        // attributes
        monitor = attributes.monitor ?? True;
        enabled = attributes.enabled ?? True;
        locked = attributes.locked ?? False;
        debug_data = attributes.debug_data ?? False;
        tags = attributes.tags ?? {};
 
        opts = validateOptions(options);
        orig_opts = opts;
        setChildCapabilities();
    }
 
protected:
     setChildCapabilities();
public:
 
 
    abstract string getType();
 
 
protected:
     abstract object getImpl(bool connect = True, *hash<auto> rtopts);
public:
};
}; // ConnectionProvider namespace