Kea 2.2.0
database_connection.h
Go to the documentation of this file.
1// Copyright (C) 2015-2022 Internet Systems Consortium, Inc. ("ISC")
2//
3// This Source Code Form is subject to the terms of the Mozilla Public
4// License, v. 2.0. If a copy of the MPL was not distributed with this
5// file, You can obtain one at http://mozilla.org/MPL/2.0/.
6
7#ifndef DATABASE_CONNECTION_H
8#define DATABASE_CONNECTION_H
9
10#include <asiolink/io_service.h>
11#include <cc/data.h>
12#include <boost/noncopyable.hpp>
13#include <boost/shared_ptr.hpp>
15#include <util/reconnect_ctl.h>
16#include <functional>
17#include <map>
18#include <string>
19
20namespace isc {
21namespace db {
22
24class NoDatabaseName : public Exception {
25public:
26 NoDatabaseName(const char* file, size_t line, const char* what) :
27 isc::Exception(file, line, what) {}
28};
29
31class DbOpenError : public Exception {
32public:
33 DbOpenError(const char* file, size_t line, const char* what) :
34 isc::Exception(file, line, what) {}
35};
36
39public:
40 DbOperationError(const char* file, size_t line, const char* what) :
41 isc::Exception(file, line, what) {}
42};
43
47public:
48 DbConnectionUnusable(const char* file, size_t line, const char* what) :
49 isc::Exception(file, line, what) {}
50};
51
52
56class InvalidType : public Exception {
57public:
58 InvalidType(const char* file, size_t line, const char* what) :
59 isc::Exception(file, line, what) {}
60};
61
66public:
67 DbInvalidTimeout(const char* file, size_t line, const char* what) :
68 isc::Exception(file, line, what) {}
69};
70
75public:
76 DbInvalidReadOnly(const char* file, size_t line, const char* what) :
77 isc::Exception(file, line, what) {}
78};
79
81typedef std::function<bool (util::ReconnectCtlPtr db_reconnect_ctl)> DbCallback;
82
91
93typedef boost::shared_ptr<IOServiceAccessor> IOServiceAccessorPtr;
94
103class DatabaseConnection : public boost::noncopyable {
104public:
105
112 static const time_t MAX_DB_TIME;
113
115 typedef std::map<std::string, std::string> ParameterMap;
116
123 DbCallback callback = DbCallback())
124 : parameters_(parameters), callback_(callback), unusable_(false) {
125 }
126
129
134 virtual void makeReconnectCtl(const std::string& timer_name);
135
140 return (reconnect_ctl_);
141 }
142
148 std::string getParameter(const std::string& name) const;
149
159 static ParameterMap parse(const std::string& dbaccess);
160
169 static std::string redactedAccessString(const ParameterMap& parameters);
170
177 bool configuredReadOnly() const;
178
183 static bool invokeDbLostCallback(const util::ReconnectCtlPtr& db_reconnect_ctl);
184
189 static bool invokeDbRecoveredCallback(const util::ReconnectCtlPtr& db_reconnect_ctl);
190
195 static bool invokeDbFailedCallback(const util::ReconnectCtlPtr& db_reconnect_ctl);
196
201 static isc::data::ElementPtr toElement(const ParameterMap& params);
202
207 static isc::data::ElementPtr toElementDbAccessString(const std::string& dbaccess);
208
212
216
220
224 if (unusable_) {
225 isc_throw (DbConnectionUnusable, "Attempt to use an invalid connection");
226 }
227 }
228
232 bool isUnusable() {
233 return (unusable_);
234 }
235
236protected:
238 void markUnusable() { unusable_ = true; }
239
240private:
241
247 ParameterMap parameters_;
248
249protected:
250
253
254private:
255
262 bool unusable_;
263
265 util::ReconnectCtlPtr reconnect_ctl_;
266};
267
268} // namespace db
269} // namespace isc
270
271#endif // DATABASE_CONNECTION_H
This is a base class for exceptions thrown from the DNS library module.
virtual const char * what() const
Returns a C-style character string of the cause of the exception.
Common database connection class.
virtual ~DatabaseConnection()
Destructor.
bool configuredReadOnly() const
Convenience method checking if database should be opened with read only access.
std::string getParameter(const std::string &name) const
Returns value of a connection parameter.
util::ReconnectCtlPtr reconnectCtl()
The reconnect settings.
static bool invokeDbLostCallback(const util::ReconnectCtlPtr &db_reconnect_ctl)
Invokes the connection's lost connectivity callback.
static std::string redactedAccessString(const ParameterMap &parameters)
Redact database access string.
void markUnusable()
Sets the unusable flag to true.
static bool invokeDbFailedCallback(const util::ReconnectCtlPtr &db_reconnect_ctl)
Invokes the connection's restore failed connectivity callback.
static isc::data::ElementPtr toElement(const ParameterMap &params)
Unparse a parameter map.
static isc::data::ElementPtr toElementDbAccessString(const std::string &dbaccess)
Unparse an access string.
static DbCallback db_recovered_callback_
Optional callback function to invoke if an opened connection recovery succeeded.
virtual void makeReconnectCtl(const std::string &timer_name)
Instantiates a ReconnectCtl based on the connection's reconnect parameters.
DatabaseConnection(const ParameterMap &parameters, DbCallback callback=DbCallback())
Constructor.
static ParameterMap parse(const std::string &dbaccess)
Parse database access string.
static bool invokeDbRecoveredCallback(const util::ReconnectCtlPtr &db_reconnect_ctl)
Invokes the connection's restored connectivity callback.
static DbCallback db_failed_callback_
Optional callback function to invoke if an opened connection recovery failed.
void checkUnusable()
Throws an exception if the connection is not usable.
static DbCallback db_lost_callback_
Optional callback function to invoke if an opened connection is lost.
bool isUnusable()
Flag which indicates if connection is unusable.
static const time_t MAX_DB_TIME
Defines maximum value for time that can be reliably stored.
std::map< std::string, std::string > ParameterMap
Database configuration parameter map.
DbCallback callback_
The callback used to recover the connection.
Exception thrown when a specific connection has been rendered unusable either through loss of connect...
DbConnectionUnusable(const char *file, size_t line, const char *what)
Invalid 'readonly' value specification.
DbInvalidReadOnly(const char *file, size_t line, const char *what)
DbInvalidTimeout(const char *file, size_t line, const char *what)
Exception thrown on failure to open database.
DbOpenError(const char *file, size_t line, const char *what)
Exception thrown on failure to execute a database function.
DbOperationError(const char *file, size_t line, const char *what)
Invalid type exception.
InvalidType(const char *file, size_t line, const char *what)
Exception thrown if name of database is not specified.
NoDatabaseName(const char *file, size_t line, const char *what)
#define isc_throw(type, stream)
A shortcut macro to insert known values into exception arguments.
boost::shared_ptr< Element > ElementPtr
Definition: data.h:24
boost::shared_ptr< IOServiceAccessor > IOServiceAccessorPtr
Pointer to an instance of IOServiceAccessor.
std::function< bool(util::ReconnectCtlPtr db_reconnect_ctl)> DbCallback
Defines a callback prototype for propagating events upward.
std::function< isc::asiolink::IOServicePtr()> IOServiceAccessor
Function which returns the IOService that can be used to recover the connection.
boost::shared_ptr< ReconnectCtl > ReconnectCtlPtr
Pointer to an instance of ReconnectCtl.
Defines the logger used by the top-level component of kea-lfc.