Qore ConnectionProvider Module Reference  1.3
ConnectionProvider.qm.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
3 
4 /* ConnectionProvider.qm Copyright 2016 - 2019 Qore Technologies, s.r.o.
5 
6  Permission is hereby granted, free of charge, to any person obtaining a
7  copy of this software and associated documentation files (the "Software"),
8  to deal in the Software without restriction, including without limitation
9  the rights to use, copy, modify, merge, publish, distribute, sublicense,
10  and/or sell copies of the Software, and to permit persons to whom the
11  Software is furnished to do so, subject to the following conditions:
12 
13  The above copyright notice and this permission notice shall be included in
14  all copies or substantial portions of the Software.
15 
16  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22  DEALINGS IN THE SOFTWARE.
23 */
24 
25 // minimum required Qore module
26 
27 
28 
29 
123 namespace ConnectionProvider {
126 
132  *string module;
133 
135  string class_name;
136 
138  *softlist<auto> args;
139 
141 
152 
154 
164  *string pre_processing;
165  };
166 
168  public struct ConnectionInfo {
169  string name;
170  string desc;
172  bool loopback;
173  bool monitor;
175  string status;
176  string type;
177  bool up = False;
179  string url;
181  bool enabled;
182  bool locked;
183  bool debug_data;
184  hash<auto> tags;
186  };
187 
189  public struct ConfigInfo {
190  string name;
191  string desc;
192  string url;
194  };
195 
197  public struct PingInfo {
198  string name;
199  string desc;
201  string url;
202  bool ok;
204  string info;
206  *hash<ExceptionInfo> ex;
207  };
208 
210 
225  string get_connection_url(string str);
226 
227 
229 
244  AbstractConnection get_connection(string conn);
245 
246 
248 
263  *hash<string, AbstractConnection> get_connections(*bool verbose);
264 
265 
267 
282  *hash<string, hash<ConnectionInfo>> get_connection_hash(*bool verbose);
283 
284 }; // ConnectionProvider namespace
285 
286 // private, non-exported namespace
287 namespace Priv {
288  *hash priv_try_get_connections(string mod);
289 
290 
291  ConnectionProvider::AbstractConnection priv_try_get_connection(string mod, string conn);
292 
293 }; // Priv nsmrspace
*hash< string, AbstractConnection > get_connections(*bool verbose)
returns all known connections as a hash keyed by connection identifier; values are AbstractConnection...
date date(date dt)
*hash opts
the options set on the connection
Definition: ConnectionProvider.qm.dox.h:193
information that can be used to dynamically construct a connection object
Definition: ConnectionProvider.qm.dox.h:130
*date last_check
the date/time value of the last connection check (or NOTHING if not checked)
Definition: ConnectionProvider.qm.dox.h:171
string name
the connection name
Definition: ConnectionProvider.qm.dox.h:169
string class_name
the name of the constructor's class
Definition: ConnectionProvider.qm.dox.h:135
string status
a string giving the connection's status
Definition: ConnectionProvider.qm.dox.h:175
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
string info
a string giving the result of the ping ("OK" or an error message)
Definition: ConnectionProvider.qm.dox.h:204
*string pre_processing
code to execute before construction to preprocess the constructor arguments
Definition: ConnectionProvider.qm.dox.h:164
string url
the full URL (including any username & password)
Definition: ConnectionProvider.qm.dox.h:192
AbstractConnection get_connection(string conn)
returns an AbstractConnection object if the identifier is known to a registered connection provider
*date updated
the date/time value of the update (or NOTHING if not updated)
Definition: ConnectionProvider.qm.dox.h:178
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
*hash< ExceptionInfo > ex
if an exception occured, all exception info will be returned here
Definition: ConnectionProvider.qm.dox.h:206
const False
abstract base class for connections
Definition: AbstractConnection.qc.dox.h:31
*softlist< auto > args
the constructor arguments
Definition: ConnectionProvider.qm.dox.h:138
ping response info as returned by AbstractConnection::ping()
Definition: ConnectionProvider.qm.dox.h:197
string name
the name of the connection
Definition: ConnectionProvider.qm.dox.h:190
*string post_processing
code to execute after construction
Definition: ConnectionProvider.qm.dox.h:151
string type
the connection type
Definition: ConnectionProvider.qm.dox.h:176
string url
a safe version of the URL (without passwords)
Definition: ConnectionProvider.qm.dox.h:201
bool monitor
a boolean vaue indicating if the connection should be monitored or not
Definition: ConnectionProvider.qm.dox.h:173
*hash opts
the options set on the connection
Definition: ConnectionProvider.qm.dox.h:200
config informaton as returned by AbstractConnection::getConfigHash()
Definition: ConnectionProvider.qm.dox.h:189
bool debug_data
a boolean value indicating whether the connection should be subject to data debugging....
Definition: ConnectionProvider.qm.dox.h:183
hash url_hash
a hash of URL information as returned by parse_url()
Definition: ConnectionProvider.qm.dox.h:180
bool loopback
a boolean vaue indicating if the connection is a loopback connection
Definition: ConnectionProvider.qm.dox.h:172
string desc
the description
Definition: ConnectionProvider.qm.dox.h:191
date time
a relative date/time value giving the elapsed time of the ping operation
Definition: ConnectionProvider.qm.dox.h:203
*hash opts
the original options used to create the object
Definition: ConnectionProvider.qm.dox.h:174
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
string desc
the description
Definition: ConnectionProvider.qm.dox.h:199
hash< auto > hash(object obj)
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
hash< auto > tags
user-defined key-value pairs associated with the connection
Definition: ConnectionProvider.qm.dox.h:184
string name
the name of the connection
Definition: ConnectionProvider.qm.dox.h:198
string get_connection_url(string str)
returns a URL string for the given identifier if the identifier is known to a registered connection p...
connection information hash as returned by AbstractConnection::getInfo()
Definition: ConnectionProvider.qm.dox.h:168
bool ok
a boolean value giving the result of the ping
Definition: ConnectionProvider.qm.dox.h:202
*hash< string, hash< ConnectionInfo > > get_connection_hash(*bool verbose)
returns a hash of connection information keyed by connection identifier; values are ConnectionInfo ha...
*hash ping_info
an optional free-form hash giving additional info regarding ping operation or the remote system
Definition: ConnectionProvider.qm.dox.h:205
string desc
the connection description
Definition: ConnectionProvider.qm.dox.h:170
*string module
any module required to be loaded for the constructor call
Definition: ConnectionProvider.qm.dox.h:132
the ConnectionProvider namespace. All classes used in the ConnectionProvider module should be inside ...
Definition: AbstractConnection.qc.dox.h:27
bool has_provider
if the connection supports the data provider API
Definition: ConnectionProvider.qm.dox.h:185