| Qore ConnectionProvider Module Reference 2.0.1

Loading...
Searching...
No Matches
UpdateOptionsInterface.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
2// Qore UpdateOptionsInterface class definition
3
4/* UpdateOptionsInterface.qc Copyright 2016 - 2024 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
26
28 namespace ConnectionProvider {
30 class UpdateOptionsInterface : public Qore::Serializable {
31
32 public:
33 protected:
35
38 transient *code update_options;
39
41 transient LoggerInterface postpone_update_options_logger;
42
44 transient bool postpone_update_options;
45
47 transient *hash<auto> pending_options;
48
49 public:
50
52
55 setUpdateOptionsCode(*code update_options);
56
57
59
61 postponeUpdateOptions(*LoggerInterface logger);
62
63
65 flushOptionUpdates();
66
67
69 protected:
70 doUpdateOptions(*LoggerInterface logger, hash<auto> new_opts);
71 public:
72
73};
74};
ConnectionProvider::UpdateOptionsInterface
Interface class inherited by connection classes that declare the AbstractConnection::CF_UPDATE_OPTION...
Definition UpdateOptionsInterface.qc.dox.h:30
ConnectionProvider::UpdateOptionsInterface::flushOptionUpdates
flushOptionUpdates()
Set update options calls to no longer be postponed.
ConnectionProvider::UpdateOptionsInterface::postpone_update_options_logger
transient LoggerInterface postpone_update_options_logger
Logger when postponing update options calls.
Definition UpdateOptionsInterface.qc.dox.h:41
ConnectionProvider::UpdateOptionsInterface::update_options
transient *code update_options
Closure or call reference to be called when connection options should be automatically updated.
Definition UpdateOptionsInterface.qc.dox.h:38
ConnectionProvider::UpdateOptionsInterface::setUpdateOptionsCode
setUpdateOptionsCode(*code update_options)
Can be called to set or clear a closure or call reference to be called when options are automatically...
ConnectionProvider::UpdateOptionsInterface::postpone_update_options
transient bool postpone_update_options
Flag to postpone update options calls.
Definition UpdateOptionsInterface.qc.dox.h:44
ConnectionProvider::UpdateOptionsInterface::pending_options
transient *hash< auto > pending_options
Storage for postponed options to update.
Definition UpdateOptionsInterface.qc.dox.h:47
ConnectionProvider::UpdateOptionsInterface::doUpdateOptions
doUpdateOptions(*LoggerInterface logger, hash< auto > new_opts)
Performs the option update in the external system.
ConnectionProvider::UpdateOptionsInterface::postponeUpdateOptions
postponeUpdateOptions(*LoggerInterface logger)
Set update options calls to be postponed.
Qore::Serializable
ConnectionProvider
The ConnectionProvider namespace.
Definition AbstractConnection.qc.dox.h:28