Qore ConnectionProvider Module Reference 1.7.3
Loading...
Searching...
No Matches
ConnectionProvider.qm.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
4/* ConnectionProvider.qm Copyright 2016 - 2023 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
180
182namespace ConnectionProvider {
184
190 *string module;
191
194
196 *softlist<auto> args;
197
199
210
212
223};
224
226
228public struct ConnectionInfo {
230 string name;
231
233 string desc;
234
237
240
243
245 *hash opts;
246
248 string status;
249
251 string type;
252
254 bool up = False;
255
257 *date updated;
258
260
262 string url;
263
266
268
271
273
275 bool locked;
276
278
281
283 hash<auto> tags;
284
286 bool has_provider = False;
287
290
293
296
299};
300
302
304public struct ConfigInfo {
305 string name;
306 string desc;
307 string url;
308 *hash opts;
309};
310
312
314public struct PingInfo {
315 string name;
317
318 string desc;
320
321 *hash opts;
323
324 string url;
326
327 bool ok;
329
330 date time;
332
333 string info;
335
338
340 *hash<ExceptionInfo> ex;
341};
342
344
359 string get_connection_url(string str);
360
361
363
379
380
382
397 *hash<string, AbstractConnection> get_connections(*bool verbose);
398
399
401
416 *hash<string, hash<ConnectionInfo>> get_connection_hash(*bool verbose);
417
418}; // ConnectionProvider namespace
419
420// private, non-exported namespace
421namespace Priv {
422*hash priv_try_get_connections(string mod);
423
424
425ConnectionProvider::AbstractConnection priv_try_get_connection(string mod, string conn);
426
427}; // Priv nsmrspace
abstract base class for connections
Definition: AbstractConnection.qc.dox.h:34
The ConnectionProvider namespace.
Definition: AbstractConnection.qc.dox.h:28
string get_connection_url(string str)
returns a URL string for the given identifier if the identifier is known to a registered connection p...
*hash< string, AbstractConnection > get_connections(*bool verbose)
returns all known connections as a hash keyed by connection identifier; values are AbstractConnection...
AbstractConnection get_connection(string conn)
returns an AbstractConnection object if the identifier is known to a registered connection provider
*hash< string, hash< ConnectionInfo > > get_connection_hash(*bool verbose)
returns a hash of connection information keyed by connection identifier; values are ConnectionInfo ha...
config informaton
Definition: ConnectionProvider.qm.dox.h:304
*hash opts
the options set on the connection
Definition: ConnectionProvider.qm.dox.h:308
string name
the name of the connection
Definition: ConnectionProvider.qm.dox.h:305
string desc
the description
Definition: ConnectionProvider.qm.dox.h:306
string url
the full URL (including any username & password)
Definition: ConnectionProvider.qm.dox.h:307
information that can be used to dynamically construct a connection object
Definition: ConnectionProvider.qm.dox.h:188
string class_name
the name of the constructor's class
Definition: ConnectionProvider.qm.dox.h:193
*string module
any module required to be loaded for the constructor call
Definition: ConnectionProvider.qm.dox.h:190
*string pre_processing
code to execute before construction to preprocess the constructor arguments
Definition: ConnectionProvider.qm.dox.h:222
*string post_processing
code to execute after construction
Definition: ConnectionProvider.qm.dox.h:209
*softlist< auto > args
the constructor arguments
Definition: ConnectionProvider.qm.dox.h:196
connection information hash
Definition: ConnectionProvider.qm.dox.h:228
hash< auto > tags
user-defined key-value pairs associated with the connection
Definition: ConnectionProvider.qm.dox.h:283
bool children_can_support_records
if the data provider or any of its children support records
Definition: ConnectionProvider.qm.dox.h:292
bool loopback
a boolean vaue indicating if the connection is a loopback connection
Definition: ConnectionProvider.qm.dox.h:239
bool has_provider
if the connection supports the data provider API
Definition: ConnectionProvider.qm.dox.h:286
*date last_check
the date/time value of the last connection check (or NOTHING if not checked)
Definition: ConnectionProvider.qm.dox.h:236
*hash opts
the original options used to create the object
Definition: ConnectionProvider.qm.dox.h:245
bool children_can_support_apis
if the data provider or any of its children support requests (APIs)
Definition: ConnectionProvider.qm.dox.h:289
bool monitor
a boolean vaue indicating if the connection should be monitored or not
Definition: ConnectionProvider.qm.dox.h:242
bool up
a boolean vaue indicating the connection is known to be up (will be False if not checked)
Definition: ConnectionProvider.qm.dox.h:254
bool children_can_support_messages
if the data provider or any of its children support messages
Definition: ConnectionProvider.qm.dox.h:298
bool locked
a boolean value indicating whether the connection is locked or not
Definition: ConnectionProvider.qm.dox.h:275
string name
the connection name
Definition: ConnectionProvider.qm.dox.h:230
string type
the connection type
Definition: ConnectionProvider.qm.dox.h:251
*date updated
the date/time value of the update (or NOTHING if not updated)
Definition: ConnectionProvider.qm.dox.h:257
bool enabled
a boolean value indicating if the connection should be enabled or not
Definition: ConnectionProvider.qm.dox.h:270
bool debug_data
a boolean value indicating whether the connection should be subject to data debugging
Definition: ConnectionProvider.qm.dox.h:280
bool children_can_support_observers
if the data provider or any of its children support events
Definition: ConnectionProvider.qm.dox.h:295
string status
a string giving the connection's status
Definition: ConnectionProvider.qm.dox.h:248
string desc
the connection description
Definition: ConnectionProvider.qm.dox.h:233
string url
the URL for the connection including the password
Definition: ConnectionProvider.qm.dox.h:262
hash url_hash
a hash of URL information as returned by parse_url()
Definition: ConnectionProvider.qm.dox.h:265
ping response info
Definition: ConnectionProvider.qm.dox.h:314
date time
a relative date/time value giving the elapsed time of the ping operation
Definition: ConnectionProvider.qm.dox.h:330
string desc
the description
Definition: ConnectionProvider.qm.dox.h:318
*hash ping_info
an optional free-form hash giving additional info regarding ping operation or the remote system
Definition: ConnectionProvider.qm.dox.h:336
bool ok
a boolean value giving the result of the ping
Definition: ConnectionProvider.qm.dox.h:327
*hash opts
the options set on the connection
Definition: ConnectionProvider.qm.dox.h:321
string url
a safe version of the URL (without passwords)
Definition: ConnectionProvider.qm.dox.h:324
string name
the name of the connection
Definition: ConnectionProvider.qm.dox.h:315
string info
a string giving the result of the ping ("OK" or an error message)
Definition: ConnectionProvider.qm.dox.h:333