ConnectionProvider.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  ConnectionProvider.qm 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.
*/
 
// minimum required Qore module
 
 
 
 
 
namespace ConnectionProvider {
 
public hashdecl ConnectionConstructorInfo {
    *string module;
 
    string class_name;
 
    *softlist<auto> args;
 
 
    *string post_processing;
 
 
    *string pre_processing;
};
 
 
public hashdecl 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;
 
    bool children_can_support_apis = False;
 
    bool children_can_support_records = False;
 
    bool children_can_support_observers = False;
 
    bool children_can_support_messages = False;
};
 
 
public hashdecl ConfigInfo {
    string name;  
    string desc;  
    string url;   
    *hash opts;   
};
 
 
public hashdecl 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