├── Tests ├── empty_config.json ├── test_resources.qrc ├── database │ ├── testHelpers │ │ ├── helperfunctions.h │ │ ├── PrgLog.h │ │ ├── PrgLog.cpp │ │ ├── helperfunctions.cpp │ │ ├── asyncconnectionuser.h │ │ └── asyncconnectionuser.cpp │ ├── poolconfigtest.h │ ├── connectionpooltest.h │ ├── databaseconnectiontest.h │ ├── poolconfigtest.cpp │ ├── databaseconnectiontest.cpp │ └── connectionpooltest.cpp ├── individual_config.json ├── test_db.json ├── main.cpp └── Tests.pro ├── .gitignore ├── main.pro ├── QtConnectionPool ├── database │ ├── poolStats.h │ ├── databaseconfig.h │ ├── poolconfig.h │ ├── connection.h │ ├── databaseconfig.cpp │ ├── connectionpool.h │ ├── connectionpoolprivate.h │ ├── connectionpool.cpp │ ├── poolconfig.cpp │ ├── connection.cpp │ └── connectionpoolprivate.cpp └── QtConnectionPool.pro ├── README.md └── LICENSE /Tests/empty_config.json: -------------------------------------------------------------------------------- 1 | {} 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | build/ 2 | build-*/ 3 | *~ 4 | *.user* 5 | bin 6 | -------------------------------------------------------------------------------- /main.pro: -------------------------------------------------------------------------------- 1 | TEMPLATE = subdirs 2 | 3 | SUBDIRS = \ 4 | QtConnectionPool \ 5 | Tests 6 | 7 | Tests.depends = QtConnectionPool 8 | -------------------------------------------------------------------------------- /Tests/test_resources.qrc: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | empty_config.json 5 | individual_config.json 6 | test_db.json 7 | 8 | 9 | -------------------------------------------------------------------------------- /Tests/database/testHelpers/helperfunctions.h: -------------------------------------------------------------------------------- 1 | #ifndef HELPERFUNCTIONS_H 2 | #define HELPERFUNCTIONS_H 3 | 4 | #include 5 | #include 6 | 7 | namespace QtConnectionPool { 8 | namespace HelperFunctions { 9 | QString getTestSqlQueryForDriver(const QSqlDriver* driver); 10 | } 11 | } 12 | #endif // HELPERFUNCTIONS_H 13 | -------------------------------------------------------------------------------- /Tests/database/poolconfigtest.h: -------------------------------------------------------------------------------- 1 | #ifndef POOLCONFIGTEST_H 2 | #define POOLCONFIGTEST_H 3 | 4 | #include 5 | #include 6 | 7 | class PoolConfigTest : public QObject 8 | { 9 | Q_OBJECT 10 | 11 | private slots: 12 | void initTestCase(); 13 | void testIndividualValues(); 14 | void testDefaultValues(); 15 | }; 16 | 17 | #endif // POOLCONFIGTEST_H 18 | -------------------------------------------------------------------------------- /Tests/database/testHelpers/PrgLog.h: -------------------------------------------------------------------------------- 1 | #ifndef QTCONNECTIONPOOL_PRGLOG_H 2 | #define QTCONNECTIONPOOL_PRGLOG_H 3 | 4 | #include 5 | #include 6 | 7 | namespace QtConnectionPool { 8 | namespace PrgLog { 9 | void qtMessageOutput(QtMsgType msgtype, const QMessageLogContext &context, const QString &msg); 10 | } 11 | } 12 | 13 | #endif //QTCONNECTIONPOOL_PRGLOG_H 14 | -------------------------------------------------------------------------------- /QtConnectionPool/database/poolStats.h: -------------------------------------------------------------------------------- 1 | #ifndef QTCONNECTIONPOOL_POOLSTATS_H 2 | #define QTCONNECTIONPOOL_POOLSTATS_H 3 | 4 | namespace QtConnectionPool { 5 | struct PoolStats { 6 | uint16_t _nbAvailable; 7 | uint16_t _nbBorrowed; 8 | PoolStats() 9 | : _nbAvailable(0) 10 | , _nbBorrowed(0) 11 | {} 12 | }; 13 | } 14 | 15 | #endif //QTCONNECTIONPOOL_POOLSTATS_H 16 | -------------------------------------------------------------------------------- /Tests/individual_config.json: -------------------------------------------------------------------------------- 1 | { 2 | "connectionPool": { 3 | "checkInterval": 30000, 4 | "minConnections": 2, 5 | "maxConnections": 7, 6 | "connectionLifePeriod": 600000, 7 | "database": { 8 | "driver": "OCI", 9 | "host": "happy-host.com", 10 | "port": 9999, 11 | "database": "happy_db", 12 | "user": "forrest_gump", 13 | "password": "xxxyyy" 14 | } 15 | } 16 | } 17 | -------------------------------------------------------------------------------- /Tests/test_db.json: -------------------------------------------------------------------------------- 1 | { 2 | "connectionPool": { 3 | "checkInterval": 30000, 4 | "minConnections": 2, 5 | "maxConnections": 5, 6 | "connectionLifePeriod": 300000, 7 | "inactivityPeriod": 600000, 8 | "database": { 9 | "driver": "QOCI", 10 | "host": "localhost", 11 | "port": 1521, 12 | "database": "xe", 13 | "user": "system", 14 | "password": "oracle" 15 | } 16 | } 17 | } 18 | -------------------------------------------------------------------------------- /Tests/database/testHelpers/PrgLog.cpp: -------------------------------------------------------------------------------- 1 | #include "PrgLog.h" 2 | #include 3 | 4 | #include 5 | 6 | namespace QtConnectionPool { 7 | void PrgLog::qtMessageOutput(QtMsgType msgtype, const QMessageLogContext &context, const QString &msg) { 8 | Q_UNUSED(msgtype); 9 | Q_UNUSED(context); 10 | 11 | //to console 12 | std::cerr << QThread::currentThreadId() << " : " << msg.toStdString().c_str() << std::endl; 13 | } 14 | } -------------------------------------------------------------------------------- /Tests/main.cpp: -------------------------------------------------------------------------------- 1 | #include "database/databaseconnectiontest.h" 2 | #include "database/poolconfigtest.h" 3 | #include "database/connectionpooltest.h" 4 | 5 | int main(int argc, char *argv[]) 6 | { 7 | QCoreApplication app(argc,argv); 8 | 9 | int status = 0; 10 | status |= QTest::qExec(new DatabaseConnectionTest(&app), argc, argv); 11 | status |= QTest::qExec(new PoolConfigTest(), argc, argv); 12 | status |= QTest::qExec(new ConnectionPoolTest(), argc, argv); 13 | 14 | return status; 15 | } 16 | -------------------------------------------------------------------------------- /Tests/database/connectionpooltest.h: -------------------------------------------------------------------------------- 1 | #ifndef CONNECTIONPOOLTEST_H 2 | #define CONNECTIONPOOLTEST_H 3 | 4 | #include 5 | #include 6 | 7 | class ConnectionPoolTest : public QObject 8 | { 9 | Q_OBJECT 10 | 11 | public: 12 | struct Handler; 13 | Handler* _dataHandler; 14 | 15 | private slots: 16 | void initTestCase(); 17 | void testExplicitUnBorrow(); 18 | void testImplicitUnBorrow(); 19 | void testAsynchronConnectionUsers(); 20 | void testCheckGetConnectionWithWait(); 21 | void testCheckConnectionPool(); 22 | void cleanupTestCase(); 23 | }; 24 | 25 | #endif // CONNECTIONPOOLTEST_H 26 | -------------------------------------------------------------------------------- /QtConnectionPool/database/databaseconfig.h: -------------------------------------------------------------------------------- 1 | #ifndef DATABASECONFIG_H 2 | #define DATABASECONFIG_H 3 | 4 | #include 5 | #include 6 | 7 | namespace QtConnectionPool { 8 | class DatabaseConfig { 9 | public: 10 | QString driver; 11 | QString host; 12 | int port; 13 | QString database; 14 | QString user; 15 | QString password; 16 | 17 | public: 18 | DatabaseConfig(); 19 | 20 | explicit DatabaseConfig(const QVariantMap& configMap); 21 | 22 | private: 23 | void readConfig(const QVariantMap &configMap); 24 | }; 25 | } 26 | 27 | #endif // DATABASECONFIG_H 28 | -------------------------------------------------------------------------------- /Tests/database/databaseconnectiontest.h: -------------------------------------------------------------------------------- 1 | #ifndef DATABASECONNECTIONTEST_H 2 | #define DATABASECONNECTIONTEST_H 3 | 4 | #include 5 | #include 6 | 7 | #include "database/connection.h" 8 | 9 | class DatabaseConnectionTest : public QObject 10 | { 11 | Q_OBJECT 12 | private: 13 | QString configFilePath; 14 | QtConnectionPool::Connection connection; 15 | 16 | public: 17 | DatabaseConnectionTest(QObject* parent); 18 | 19 | private slots: 20 | void initTestCase(); 21 | void testConnection(); 22 | void testInUse(); 23 | void testComparison(); 24 | void testGetCreationTime(); 25 | void testRefresh(); 26 | }; 27 | 28 | #endif // DATABASECONNECTIONTEST_H 29 | -------------------------------------------------------------------------------- /Tests/database/testHelpers/helperfunctions.cpp: -------------------------------------------------------------------------------- 1 | 2 | #include "helperfunctions.h" 3 | 4 | namespace QtConnectionPool { 5 | namespace HelperFunctions { 6 | 7 | QString getTestSqlQueryForDriver(const QSqlDriver* driver) 8 | { 9 | switch(driver->dbmsType()) { 10 | case QSqlDriver::DbmsType::Oracle : 11 | return QString("select 'it works' from dual"); 12 | break; 13 | case QSqlDriver::DbmsType::PostgreSQL : 14 | return QString("select 'it works'"); 15 | break; 16 | default: 17 | throw std::runtime_error("untested driver"); 18 | } 19 | } 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /QtConnectionPool/QtConnectionPool.pro: -------------------------------------------------------------------------------- 1 | TEMPLATE = lib 2 | INCLUDEPATH += $$PWD 3 | DEPENDPATH += $$PWD 4 | TARGET = qtconnectionpool 5 | 6 | QT += sql 7 | 8 | # Enable verbose behavior in debug mode 9 | CONFIG(debug, debug|release) { 10 | DEFINES += VERBOSE 11 | } 12 | 13 | HEADERS += \ 14 | $$PWD/database/poolconfig.h \ 15 | $$PWD/database/databaseconfig.h \ 16 | $$PWD/database/connectionpool.h \ 17 | $$PWD/database/connectionpoolprivate.h \ 18 | $$PWD/database/connection.h 19 | 20 | SOURCES += \ 21 | $$PWD/database/poolconfig.cpp \ 22 | $$PWD/database/databaseconfig.cpp \ 23 | $$PWD/database/connectionpool.cpp \ 24 | $$PWD/database/connectionpoolprivate.cpp \ 25 | $$PWD/database/connection.cpp 26 | 27 | DISTFILES += \ 28 | ../README.md 29 | 30 | DESTDIR = ../bin -------------------------------------------------------------------------------- /QtConnectionPool/database/poolconfig.h: -------------------------------------------------------------------------------- 1 | #ifndef POOLCONFIG_H 2 | #define POOLCONFIG_H 3 | 4 | #include 5 | #include 6 | #include 7 | 8 | #include "databaseconfig.h" 9 | 10 | namespace QtConnectionPool { 11 | class PoolConfig { 12 | public: 13 | int checkInterval; 14 | int minConnections; 15 | int maxConnections; 16 | int connectionLifePeriod; 17 | int inactivityPeriod; 18 | DatabaseConfig dbConfig; 19 | 20 | public: 21 | PoolConfig(); 22 | explicit PoolConfig(const QString& configFilePath); 23 | 24 | private: 25 | QJsonDocument readConfigFile(const QString& configFilePath); 26 | 27 | void readJsonConfig(const QJsonDocument& jsonConfig); 28 | }; 29 | } 30 | 31 | #endif // POOLCONFIG_H 32 | -------------------------------------------------------------------------------- /QtConnectionPool/database/connection.h: -------------------------------------------------------------------------------- 1 | #ifndef CONNECTION_H 2 | #define CONNECTION_H 3 | 4 | #include 5 | #include 6 | 7 | namespace QtConnectionPool { 8 | class ConnectionPrivate; 9 | class DatabaseConfig; 10 | 11 | class Connection 12 | { 13 | 14 | private: 15 | QSharedPointer databaseConnection; 16 | 17 | public: 18 | Connection(); 19 | explicit Connection(const DatabaseConfig& config); 20 | 21 | bool operator==(const Connection& other); 22 | 23 | QSqlDatabase database(); 24 | void use(); 25 | bool isInUse() const; 26 | bool isValid() const; 27 | 28 | qint64 getCreationTime() const; 29 | qint64 getLastUseTime() const; 30 | void refresh(); 31 | }; 32 | } 33 | 34 | 35 | #endif // CONNECTION_H 36 | -------------------------------------------------------------------------------- /QtConnectionPool/database/databaseconfig.cpp: -------------------------------------------------------------------------------- 1 | #include "databaseconfig.h" 2 | 3 | namespace QtConnectionPool { 4 | DatabaseConfig::DatabaseConfig() 5 | : driver() 6 | , host() 7 | , port(0) 8 | , database() 9 | , user() 10 | , password() { 11 | } 12 | 13 | DatabaseConfig::DatabaseConfig(const QVariantMap& configMap) { 14 | this->readConfig(configMap); 15 | } 16 | 17 | void DatabaseConfig::readConfig(const QVariantMap &configMap) { 18 | this->driver = configMap.value("driver", "QPSQL").toString(); 19 | this->host = configMap.value("host").toString(); 20 | this->port = configMap.value("port", 5432).toInt(); 21 | this->database = configMap.value("database").toString(); 22 | this->user = configMap.value("user").toString(); 23 | this->password = configMap.value("password").toString(); 24 | } 25 | } 26 | -------------------------------------------------------------------------------- /Tests/database/testHelpers/asyncconnectionuser.h: -------------------------------------------------------------------------------- 1 | #ifndef ASYNCCONNECTIONUSER_H 2 | #define ASYNCCONNECTIONUSER_H 3 | 4 | #include 5 | #include 6 | 7 | #include "database/connection.h" 8 | 9 | namespace QtConnectionPool { 10 | class AsyncConnectionUser : public QRunnable { 11 | private: 12 | QString name; 13 | QString result; 14 | bool success; 15 | QSharedPointer dbConnection; 16 | uint64_t waitTimeoutMS; 17 | uint64_t queryExecTimeMs; 18 | 19 | public: 20 | explicit AsyncConnectionUser(const QString& name, uint64_t waitTimeoutMS = 0, uint64_t queryExecTimeMs = 0); 21 | 22 | void run(); 23 | 24 | inline QString getResult() { return this->result; } 25 | 26 | inline bool getSuccess() { return this->success; } 27 | }; 28 | } 29 | 30 | #endif // ASYNCCONNECTIONUSER_H 31 | -------------------------------------------------------------------------------- /QtConnectionPool/database/connectionpool.h: -------------------------------------------------------------------------------- 1 | #ifndef CONNECTIONPOOL_H 2 | #define CONNECTIONPOOL_H 3 | 4 | #include 5 | #include 6 | #include 7 | #include 8 | #include 9 | #include 10 | #include 11 | #include 12 | #include 13 | #include 14 | 15 | #include "poolconfig.h" 16 | #include "poolStats.h" 17 | 18 | namespace QtConnectionPool { 19 | class PoolConfig; 20 | class Connection; 21 | class ConnectionPoolPrivate; 22 | 23 | class ConnectionPool { 24 | static ConnectionPoolPrivate* pool; 25 | 26 | public: 27 | ConnectionPool(); 28 | 29 | explicit ConnectionPool(const QString& configFilePath); 30 | explicit ConnectionPool(const PoolConfig& poolConfig); 31 | 32 | QSharedPointer getConnection(uint64_t waitTimeoutInMs = 0); 33 | void unBorrowConnection(QSharedPointer con); 34 | 35 | PoolStats getPoolStats() const; 36 | 37 | void destroy(); 38 | }; 39 | } 40 | 41 | #endif // CONNECTIONPOOL_H 42 | -------------------------------------------------------------------------------- /Tests/Tests.pro: -------------------------------------------------------------------------------- 1 | ###################################################################### 2 | # Automatically generated by qmake (3.0) Mi. Mrz 31 13:35:23 2019 3 | ###################################################################### 4 | 5 | QT += testlib sql 6 | TEMPLATE = app 7 | TARGET = qtconnectionpool_tests 8 | CONFIG += console 9 | 10 | # Input 11 | HEADERS += \ 12 | database/databaseconnectiontest.h \ 13 | database/poolconfigtest.h \ 14 | database/connectionpooltest.h \ 15 | database/testHelpers/asyncconnectionuser.h \ 16 | database/testHelpers/PrgLog.h \ 17 | database/testHelpers/helperfunctions.h 18 | SOURCES += main.cpp \ 19 | database/databaseconnectiontest.cpp \ 20 | database/poolconfigtest.cpp \ 21 | database/connectionpooltest.cpp \ 22 | database/testHelpers/asyncconnectionuser.cpp \ 23 | database/testHelpers/PrgLog.cpp \ 24 | database/testHelpers/helperfunctions.cpp 25 | 26 | #include(../QtConnectionPool/qtconnectionpool.pro) 27 | 28 | LIBS += -lqtconnectionpool -L../bin 29 | INCLUDEPATH += $$PWD/../QtConnectionPool 30 | 31 | DESTDIR = ../bin 32 | 33 | CONFIG += test_config 34 | test_config.files = $$files(etc/*.json) 35 | test_config.path = $$DESTDIR/etc 36 | 37 | RESOURCES += \ 38 | test_resources.qrc 39 | 40 | 41 | -------------------------------------------------------------------------------- /QtConnectionPool/database/connectionpoolprivate.h: -------------------------------------------------------------------------------- 1 | #ifndef CONNECTIONPOOLPRIVATE_H 2 | #define CONNECTIONPOOLPRIVATE_H 3 | 4 | #include 5 | #include 6 | #include 7 | #include 8 | 9 | #include "connection.h" 10 | #include "poolconfig.h" 11 | #include "poolStats.h" 12 | 13 | namespace QtConnectionPool { 14 | class ConnectionPoolPrivate : public QObject { 15 | Q_OBJECT 16 | Q_DISABLE_COPY(ConnectionPoolPrivate) 17 | 18 | private: 19 | PoolStats stat; 20 | const PoolConfig config; 21 | QTimer checkTimer; 22 | mutable QMutex mutex; 23 | QList> connectionPool; //available 24 | 25 | public: 26 | bool stop; 27 | QSharedPointer getConnection(uint64_t waitTimeoutInMs = 0); 28 | void unBorrowConnection(QSharedPointer con); 29 | PoolStats getPoolStats() const; 30 | 31 | static ConnectionPoolPrivate& getInstance(); 32 | static void setupPool(const PoolConfig &config, QObject *parent); 33 | 34 | private: 35 | explicit ConnectionPoolPrivate(const PoolConfig &config, QObject *parent); 36 | void initPool(); 37 | QSharedPointer createNewConnection(); 38 | 39 | private slots: 40 | void checkConnectionPool(); 41 | }; 42 | } 43 | 44 | #endif // CONNECTIONPOOLPRIVATE_H 45 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # QtConnectionPool 2 | 3 | Simple Database Connection Pool for Qt 5 Applications 4 | 5 | ## Getting Started 6 | 7 | ### Configuration 8 | 9 | The connection pool can be configured in a json file. 10 | 11 | #### Configuration example 12 | ```json 13 | { 14 | "connectionPool": { 15 | "checkInterval": 30000, 16 | "minConnections": 2, 17 | "maxConnections": 7, 18 | "connectionLifePeriod": 600000, 19 | "database": { 20 | "driver": "OCI", 21 | "host": "happy-host.com", 22 | "port": 9999, 23 | "database": "happy_db", 24 | "user": "forrest_gump", 25 | "password": "xxxyyy" 26 | } 27 | } 28 | } 29 | 30 | ``` 31 | 32 | #### Options 33 | 34 | - **checkInterval**: The used interval in milliseconds to clean up exceeded connections or to refresh open connections. Defaults to `10000` 35 | - **minConnections**: The minimal count of open connections. Defaults to `1` 36 | - **maxConnections**: The maximal count of open connections. Defaults to `1` 37 | - **connectionLifePeriod**: The maximal life period in milliseconds of an open connection. Defaults to `300000` 38 | - **driver**: The name of the db driver that should be used (see [Qt SQL Database Drivers](https://doc.qt.io/qt-5/sql-driver.html)). Defaults to: `QPSQL` 39 | - **host**: The connection's host name. **mandatory!** 40 | - **port**: The connection's port number. Defaults to `5432` 41 | - **database**: The connection's database name. **mandatory!** 42 | - **user**: The database user name. **mandatory!** 43 | - **password**: The database users password. **mandatory!** 44 | 45 | 46 | -------------------------------------------------------------------------------- /Tests/database/testHelpers/asyncconnectionuser.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | 5 | #include "asyncconnectionuser.h" 6 | #include "database/connectionpool.h" 7 | #include "helperfunctions.h" 8 | 9 | namespace QtConnectionPool { 10 | AsyncConnectionUser::AsyncConnectionUser(const QString& name, uint64_t waitTimeoutMS, uint64_t queryExecTimeMs) 11 | : QRunnable() 12 | , name(name) 13 | , result() 14 | , success(false) 15 | , dbConnection(nullptr) 16 | , waitTimeoutMS(waitTimeoutMS) 17 | , queryExecTimeMs(queryExecTimeMs) 18 | { 19 | this->setAutoDelete(false); 20 | } 21 | 22 | void AsyncConnectionUser::run() { 23 | this->dbConnection = ConnectionPool().getConnection(waitTimeoutMS); 24 | if (this->dbConnection.isNull() || !this->dbConnection->database().isOpen()) { 25 | this->result = QString("%1: failed") 26 | .arg(this->name); 27 | ConnectionPool().unBorrowConnection(this->dbConnection); 28 | return; 29 | } 30 | 31 | QSqlQuery query(this->dbConnection->database()); 32 | const QString queryString = HelperFunctions::getTestSqlQueryForDriver(query.driver()); 33 | this->success = query.exec(queryString); 34 | 35 | query.next(); 36 | QThread::msleep(queryExecTimeMs); 37 | QString queryResult = query.value(0).toString(); 38 | this->result = QString("%1: %2") 39 | .arg(this->name) 40 | .arg(queryResult); 41 | ConnectionPool().unBorrowConnection(this->dbConnection); 42 | this->dbConnection = nullptr; 43 | } 44 | } 45 | -------------------------------------------------------------------------------- /Tests/database/poolconfigtest.cpp: -------------------------------------------------------------------------------- 1 | #include "poolconfigtest.h" 2 | #include "database/poolconfig.h" 3 | #include "testHelpers/PrgLog.h" 4 | 5 | using namespace QtConnectionPool; 6 | 7 | void PoolConfigTest::initTestCase() 8 | { 9 | qInstallMessageHandler(PrgLog::qtMessageOutput); 10 | } 11 | 12 | void PoolConfigTest::testDefaultValues() 13 | { 14 | PoolConfig poolConfig(":configs/empty_config.json"); 15 | DatabaseConfig dbConfig = poolConfig.dbConfig; 16 | 17 | QCOMPARE(poolConfig.checkInterval, 10000); 18 | QCOMPARE(poolConfig.minConnections, 1); 19 | QCOMPARE(poolConfig.maxConnections, 3); 20 | QCOMPARE(poolConfig.connectionLifePeriod, 300000); 21 | 22 | QCOMPARE(dbConfig.host, QString()); 23 | QCOMPARE(dbConfig.driver, QString("QPSQL")); 24 | QCOMPARE(dbConfig.port, 5432); 25 | QCOMPARE(dbConfig.database, QString()); 26 | QCOMPARE(dbConfig.user, QString()); 27 | QCOMPARE(dbConfig.password, QString()); 28 | } 29 | 30 | void PoolConfigTest::testIndividualValues() 31 | { 32 | PoolConfig poolConfig(":configs/individual_config.json"); 33 | DatabaseConfig dbConfig = poolConfig.dbConfig; 34 | 35 | QCOMPARE(poolConfig.checkInterval, 30000); 36 | QCOMPARE(poolConfig.minConnections, 2); 37 | QCOMPARE(poolConfig.maxConnections, 7); 38 | QCOMPARE(poolConfig.connectionLifePeriod, 600000); 39 | 40 | QCOMPARE(dbConfig.host, QString("happy-host.com")); 41 | QCOMPARE(dbConfig.driver, QString("OCI")); 42 | QCOMPARE(dbConfig.port, 9999); 43 | QCOMPARE(dbConfig.database, QString("happy_db")); 44 | QCOMPARE(dbConfig.user, QString("forrest_gump")); 45 | QCOMPARE(dbConfig.password, QString("xxxyyy")); 46 | } 47 | -------------------------------------------------------------------------------- /QtConnectionPool/database/connectionpool.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include 5 | #include 6 | #include 7 | #include 8 | #include 9 | #include 10 | 11 | #include "connectionpool.h" 12 | #include "poolconfig.h" 13 | #include "connection.h" 14 | #include "connectionpoolprivate.h" 15 | 16 | namespace QtConnectionPool { 17 | 18 | ConnectionPoolPrivate* ConnectionPool::pool = 0; 19 | 20 | ConnectionPool::ConnectionPool(const QString& configFilePath) 21 | : ConnectionPool(PoolConfig(configFilePath)) 22 | {} 23 | 24 | ConnectionPool::ConnectionPool(const PoolConfig &poolConfig) { 25 | if (!pool) { 26 | ConnectionPoolPrivate::setupPool(poolConfig, nullptr); 27 | pool = &ConnectionPoolPrivate::getInstance(); 28 | } else { 29 | qWarning("ConnectionPool: already initialized, skipping configuration"); 30 | } 31 | } 32 | 33 | ConnectionPool::ConnectionPool() { 34 | if (!pool) { 35 | qFatal("ConnectionPool: pool was not initialized"); 36 | } 37 | } 38 | 39 | void ConnectionPool::destroy() { 40 | if (pool) { 41 | pool->stop = true; 42 | } 43 | } 44 | 45 | QSharedPointer ConnectionPool::getConnection(uint64_t waitTimeoutInMs) { 46 | return pool->getConnection(waitTimeoutInMs); 47 | } 48 | 49 | void ConnectionPool::unBorrowConnection(QSharedPointer con) { 50 | pool->unBorrowConnection(con); 51 | } 52 | 53 | PoolStats ConnectionPool::getPoolStats() const { 54 | return pool->getPoolStats(); 55 | } 56 | } 57 | -------------------------------------------------------------------------------- /QtConnectionPool/database/poolconfig.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | 4 | #include "poolconfig.h" 5 | 6 | namespace QtConnectionPool { 7 | PoolConfig::PoolConfig() 8 | : checkInterval(0) 9 | , minConnections(0) 10 | , maxConnections(0) 11 | , connectionLifePeriod(0) 12 | , inactivityPeriod(0) 13 | , dbConfig() { 14 | } 15 | 16 | PoolConfig::PoolConfig(const QString& configFilePath) 17 | : PoolConfig() { 18 | QJsonDocument jsonConfig = readConfigFile(configFilePath); 19 | readJsonConfig(jsonConfig); 20 | } 21 | 22 | QJsonDocument PoolConfig::readConfigFile(const QString& configFilePath) { 23 | QJsonDocument jsonConfig; 24 | 25 | QFile file(configFilePath); 26 | if (!file.open(QIODevice::ReadOnly)) { 27 | qWarning("PoolConfig: Config file '%s' cannot be opened", qPrintable(configFilePath)); 28 | jsonConfig = QJsonDocument(); 29 | } else { 30 | jsonConfig = QJsonDocument::fromJson(file.readAll()); 31 | } 32 | file.close(); 33 | 34 | return jsonConfig; 35 | } 36 | 37 | 38 | void PoolConfig::readJsonConfig(const QJsonDocument& jsonConfig) { 39 | QVariantMap configMap = jsonConfig.object().toVariantMap(); 40 | QVariantMap connectionPoolConfig = configMap.value("connectionPool", QVariantMap()).toMap(); 41 | 42 | this->checkInterval = connectionPoolConfig.value("checkInterval", 10000).toInt(); 43 | this->minConnections = connectionPoolConfig.value("minConnections", 1).toInt(); 44 | this->maxConnections = connectionPoolConfig.value("maxConnections", 3).toInt(); 45 | this->connectionLifePeriod = connectionPoolConfig.value("connectionLifePeriod", 300000).toInt(); 46 | this->inactivityPeriod = connectionPoolConfig.value("inactivityPeriod", 47 | 600000).toInt(); //temps apres lequel on drop la co 48 | this->dbConfig = DatabaseConfig(connectionPoolConfig.value("database").toMap()); 49 | } 50 | } -------------------------------------------------------------------------------- /Tests/database/databaseconnectiontest.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | 5 | #include "databaseconnectiontest.h" 6 | #include "database/poolconfig.h" 7 | #include "testHelpers/PrgLog.h" 8 | #include "testHelpers/helperfunctions.h" 9 | 10 | using namespace QtConnectionPool; 11 | 12 | DatabaseConnectionTest::DatabaseConnectionTest(QObject* parent) : 13 | QObject(parent) 14 | { 15 | this->configFilePath = ":configs/test_db.json"; 16 | } 17 | 18 | void DatabaseConnectionTest::initTestCase() 19 | { 20 | PoolConfig poolConfig(this->configFilePath); 21 | this->connection = Connection(poolConfig.dbConfig); 22 | qInstallMessageHandler(PrgLog::qtMessageOutput); 23 | } 24 | 25 | void DatabaseConnectionTest::testConnection() 26 | { 27 | QSqlQuery query(this->connection.database()); 28 | bool ok = query.exec(HelperFunctions::getTestSqlQueryForDriver(query.driver())); 29 | QCOMPARE(ok, true); 30 | 31 | query.next(); 32 | QString result = query.value(0).toString(); 33 | QCOMPARE(result, QString("it works")); 34 | } 35 | 36 | void DatabaseConnectionTest::testInUse() 37 | { 38 | QCOMPARE(this->connection.isInUse(), false); 39 | this->connection.use(); 40 | QCOMPARE(this->connection.isInUse(), true); 41 | } 42 | 43 | void DatabaseConnectionTest::testComparison() 44 | { 45 | Connection myConn; 46 | 47 | QCOMPARE((this->connection == myConn), false); 48 | 49 | myConn = this->connection; 50 | 51 | QCOMPARE((this->connection == myConn), true); 52 | } 53 | 54 | void DatabaseConnectionTest::testGetCreationTime() 55 | { 56 | PoolConfig poolConfig(this->configFilePath); 57 | Connection myConn(poolConfig.dbConfig); 58 | 59 | QThread::msleep(10); 60 | 61 | QCOMPARE((myConn.getCreationTime() < QDateTime::currentMSecsSinceEpoch()), true); 62 | } 63 | 64 | void DatabaseConnectionTest::testRefresh() 65 | { 66 | PoolConfig poolConfig(this->configFilePath); 67 | Connection myConn(poolConfig.dbConfig); 68 | 69 | qint64 initialTimeStamp = myConn.getCreationTime(); 70 | 71 | QCOMPARE(myConn.database().open(), true); 72 | myConn.refresh(); 73 | QCOMPARE(myConn.database().open(), true); 74 | QCOMPARE((myConn.getCreationTime() > initialTimeStamp), true); 75 | } 76 | 77 | -------------------------------------------------------------------------------- /QtConnectionPool/database/connection.cpp: -------------------------------------------------------------------------------- 1 | #include "connection.h" 2 | 3 | #include 4 | #include 5 | #include 6 | #include 7 | #include 8 | #include 9 | 10 | #include "databaseconfig.h" 11 | 12 | namespace QtConnectionPool { 13 | class ConnectionPrivate { 14 | Q_DISABLE_COPY(ConnectionPrivate) 15 | 16 | private: 17 | bool inUse; 18 | bool valid; 19 | QString dbId; 20 | qint64 creationTime; 21 | qint64 lastUseTime; 22 | QSqlDatabase db; 23 | 24 | public: 25 | explicit ConnectionPrivate(const DatabaseConfig& config); 26 | 27 | QSqlDatabase &database(); 28 | 29 | qint64 getCreationTime() const; 30 | 31 | qint64 getLastUseTime() const; 32 | 33 | void refresh(); 34 | 35 | void use(); 36 | 37 | void unUse(); 38 | 39 | bool isInUse() const; 40 | 41 | bool isValid() const; 42 | }; 43 | 44 | ConnectionPrivate::ConnectionPrivate(const DatabaseConfig& config) 45 | : inUse(false) 46 | , valid(false) 47 | , dbId(QUuid::createUuid().toString()) 48 | , creationTime(QDateTime::currentMSecsSinceEpoch()) 49 | , lastUseTime(0) 50 | , db() 51 | { 52 | this->db = QSqlDatabase::addDatabase(config.driver, dbId); 53 | this->db.setHostName(config.host); 54 | this->db.setPort(config.port); 55 | this->db.setDatabaseName(config.database); 56 | this->db.setUserName(config.user); 57 | this->db.setPassword(config.password); 58 | 59 | valid = true; 60 | this->refresh(); 61 | } 62 | 63 | QSqlDatabase& ConnectionPrivate::database() { 64 | return this->db; 65 | } 66 | 67 | void ConnectionPrivate::refresh() { 68 | valid = false; 69 | if (this->db.isOpen()) { 70 | this->db.close(); 71 | } 72 | this->db.open(); 73 | 74 | if (this->db.isOpenError()) { 75 | qWarning("DatabaseConnection: Error at DatabaseConnection refresh(%s)", 76 | qPrintable(this->db.lastError().text())); 77 | } else { 78 | //qDebug("ConnectionPrivate::refresh opened db successfully"); 79 | valid = true; 80 | this->creationTime = QDateTime::currentMSecsSinceEpoch(); 81 | } 82 | } 83 | 84 | qint64 ConnectionPrivate::getCreationTime() const { 85 | return this->creationTime; 86 | } 87 | 88 | qint64 ConnectionPrivate::getLastUseTime() const { 89 | return this->lastUseTime; 90 | } 91 | 92 | void ConnectionPrivate::use() { 93 | //qDebug("ConnectionPrivate reserved by threadID=%p",QThread::currentThreadId()); 94 | this->inUse = true; 95 | this->lastUseTime = QDateTime::currentMSecsSinceEpoch(); 96 | } 97 | 98 | void ConnectionPrivate::unUse() { 99 | //qDebug("ConnectionPrivate release by threadID=%p",QThread::currentThreadId()); 100 | this->inUse = false; 101 | } 102 | 103 | bool ConnectionPrivate::isInUse() const { 104 | return this->inUse; 105 | } 106 | 107 | bool ConnectionPrivate::isValid() const { 108 | return this->valid; 109 | } 110 | 111 | 112 | Connection::Connection() 113 | : databaseConnection(0) { 114 | } 115 | 116 | Connection::Connection(const DatabaseConfig& config) 117 | : databaseConnection(new ConnectionPrivate(config)) { 118 | qDebug("new databaseConnection"); 119 | } 120 | 121 | bool Connection::operator==(const Connection& other) { 122 | return this->databaseConnection == other.databaseConnection; 123 | } 124 | 125 | QSqlDatabase Connection::database() { 126 | if (!this->databaseConnection) { 127 | return QSqlDatabase(); 128 | } 129 | return this->databaseConnection->database(); 130 | } 131 | 132 | void Connection::use() { 133 | if (!this->databaseConnection) { 134 | return; 135 | } 136 | this->databaseConnection->use(); 137 | } 138 | 139 | bool Connection::isInUse() const { 140 | if (!this->databaseConnection) { 141 | return false; 142 | } 143 | 144 | return databaseConnection->isInUse(); 145 | } 146 | 147 | bool Connection::isValid() const { 148 | if (!this->databaseConnection) { 149 | return false; 150 | } 151 | 152 | return databaseConnection->isValid(); 153 | } 154 | 155 | void Connection::refresh() { 156 | if (!this->databaseConnection) { 157 | return; 158 | } 159 | 160 | return databaseConnection->refresh(); 161 | } 162 | 163 | qint64 Connection::getCreationTime() const { 164 | if (!this->databaseConnection) { 165 | return 0; 166 | } 167 | 168 | return databaseConnection->getCreationTime(); 169 | } 170 | 171 | qint64 Connection::getLastUseTime() const { 172 | if (!this->databaseConnection) { 173 | return 0; 174 | } 175 | 176 | return databaseConnection->getLastUseTime(); 177 | } 178 | } -------------------------------------------------------------------------------- /QtConnectionPool/database/connectionpoolprivate.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include 5 | #include 6 | 7 | #include "connectionpoolprivate.h" 8 | 9 | namespace QtConnectionPool { 10 | namespace { 11 | PoolConfig g_config; 12 | QObject* g_parent; 13 | 14 | static void unBorrowDeleteHandler(Connection* obj) { 15 | //qDebug("Entering unBorrowDeleteHandler obj=%p", obj); 16 | ConnectionPoolPrivate& privatePoolInstance = ConnectionPoolPrivate::getInstance(); 17 | if (!privatePoolInstance.stop) { 18 | privatePoolInstance.unBorrowConnection(QSharedPointer(obj, unBorrowDeleteHandler)); 19 | } 20 | } 21 | } 22 | 23 | ConnectionPoolPrivate& ConnectionPoolPrivate::getInstance() { 24 | static ConnectionPoolPrivate instance(g_config, g_parent); 25 | return instance; 26 | } 27 | 28 | void ConnectionPoolPrivate::setupPool(const PoolConfig &config, QObject *parent) { 29 | g_config = config; 30 | g_parent = parent; 31 | } 32 | 33 | ConnectionPoolPrivate::ConnectionPoolPrivate(const PoolConfig& config, QObject* parent) 34 | : QObject(parent) 35 | , stat() 36 | , config(config) 37 | , checkTimer() 38 | , mutex(QMutex::Recursive) 39 | , connectionPool() 40 | , stop(false) 41 | { 42 | this->initPool(); 43 | 44 | qDebug("Scheduling checkConnectionPool in =%d",this->config.checkInterval); 45 | this->checkTimer.start(this->config.checkInterval); 46 | connect(&checkTimer, SIGNAL(timeout()), SLOT(checkConnectionPool())); 47 | } 48 | 49 | void ConnectionPoolPrivate::initPool() { 50 | qDebug("ConnectionPoolPrivate::initPool"); 51 | QMutexLocker locker(&mutex); 52 | const int minConnections = this->config.minConnections; 53 | for (int i = 0; i < minConnections; ++i) { 54 | this->connectionPool.append(this->createNewConnection()); 55 | } 56 | stat._nbAvailable = this->connectionPool.size(); 57 | } 58 | 59 | PoolStats ConnectionPoolPrivate::getPoolStats() const { 60 | QMutexLocker locker(&mutex); 61 | return stat; 62 | } 63 | 64 | void ConnectionPoolPrivate::unBorrowConnection(QSharedPointer con) { 65 | //qDebug("ConnectionPoolPrivate::unBorrowConnection received unborrow notification"); 66 | if (!con.isNull()) { 67 | QMutexLocker locker(&mutex); 68 | this->connectionPool.push_back(con); 69 | ++stat._nbAvailable; 70 | --stat._nbBorrowed; 71 | if(!this->checkTimer.isActive()){ 72 | qDebug("Reactivate timer for =%d",this->config.checkInterval); 73 | this->checkTimer.start(this->config.checkInterval); 74 | } 75 | } 76 | } 77 | 78 | QSharedPointer ConnectionPoolPrivate::getConnection(uint64_t waitTimeoutInMs) { 79 | //qDebug("ConnectionPoolPrivate::getConnection waitTimeoutInMs=%lu",waitTimeoutInMs); 80 | { 81 | QMutexLocker locker(&mutex); 82 | //qDebug("ConnectionPoolPrivate::getConnection _nbAvailable=%d, _nbBorrowed=%d",stat._nbAvailable,stat._nbBorrowed); 83 | if(stat._nbAvailable > 0){ 84 | QSharedPointer connection = connectionPool.front(); 85 | this->connectionPool.pop_front(); 86 | --stat._nbAvailable; //upd _nbAvailable size 87 | ++stat._nbBorrowed; 88 | connection->use(); 89 | return connection; 90 | } else if(stat._nbBorrowed < this->config.maxConnections) { 91 | //let create a new and borrow it right away 92 | QSharedPointer newConnection = this->createNewConnection(); 93 | ++stat._nbBorrowed; //upd _nbBorrowed size 94 | newConnection->use(); 95 | return newConnection; 96 | } 97 | } 98 | 99 | //else we need to wait a thread has finish to have a working connection 100 | if (waitTimeoutInMs > 0) { 101 | const qint64 startWait = QDateTime::currentMSecsSinceEpoch(); 102 | qDebug("ConnectionPoolPrivate::getConnection waiting for connection with waitTimeoutInMs=%lu, startWait=%llu",waitTimeoutInMs,startWait); 103 | while (1) { 104 | auto con = getConnection(0); 105 | if (con && con->isValid()) { 106 | return con; 107 | } 108 | const qint64 now = QDateTime::currentMSecsSinceEpoch(); 109 | if (static_cast(now - startWait) > waitTimeoutInMs) { //timeout expired 110 | qDebug("ConnectionPoolPrivate::getConnection timeout=%lu expired, now=%llu",waitTimeoutInMs,now); 111 | break; 112 | } 113 | QThread::usleep(10*1000); 114 | //QThread::yieldCurrentThread(); 115 | } 116 | } 117 | 118 | return QSharedPointer(nullptr); //invalid con 119 | } 120 | 121 | QSharedPointer ConnectionPoolPrivate::createNewConnection() { 122 | return QSharedPointer(new Connection(this->config.dbConfig), unBorrowDeleteHandler ); 123 | } 124 | 125 | //manage the pool size 126 | void ConnectionPoolPrivate::checkConnectionPool() { 127 | qDebug("Starting checkConnectionPool"); 128 | const qint64 now = QDateTime::currentMSecsSinceEpoch(); 129 | const qint64 connectionLifePeriod = this->config.connectionLifePeriod; 130 | const qint64 inactivityPeriod = this->config.inactivityPeriod; 131 | const int minConnections = this->config.minConnections; 132 | 133 | int excessCounter=0; 134 | { //mutex scope 135 | QMutexLocker locker(&mutex); 136 | if(stat._nbAvailable) { 137 | qDebug("Starting checkConnectionPool, ConnectionPoolPrivate: pool size is now %d=%d", this->connectionPool.size(), stat._nbAvailable); 138 | QMutableListIterator> connectionsIterator(this->connectionPool); 139 | while (connectionsIterator.hasNext()) { //they are all unused here 140 | QSharedPointer& connection = connectionsIterator.next(); 141 | if (++excessCounter > minConnections) { 142 | if ((now - connection->getLastUseTime()) > inactivityPeriod) { 143 | qDebug("Removing inactive connection id="); //show ID 144 | connection.reset(); //remove the custom deleter 145 | this->connectionPool.removeOne(connection); 146 | } 147 | break; 148 | } else if ((now - connection->getCreationTime()) > connectionLifePeriod) { 149 | connection->refresh(); 150 | } 151 | } 152 | stat._nbAvailable = this->connectionPool.size(); //maj nb available 153 | 154 | qDebug("End checkConnectionPool, ConnectionPoolPrivate: Unused Connection removed, pool size is now %d=%d", connectionPool.size(),stat._nbAvailable); 155 | if(!stop && stat._nbAvailable>0){ 156 | qDebug("Rescheduling timer for =%d",this->config.checkInterval); 157 | this->checkTimer.start(this->config.checkInterval); 158 | } 159 | } 160 | } 161 | 162 | } 163 | 164 | 165 | 166 | } 167 | -------------------------------------------------------------------------------- /Tests/database/connectionpooltest.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | 3 | #include "database/poolconfig.h" 4 | #include "database/connectionpool.h" 5 | 6 | #include "connectionpooltest.h" 7 | #include "testHelpers/asyncconnectionuser.h" 8 | #include "testHelpers/PrgLog.h" 9 | 10 | using namespace QtConnectionPool; 11 | 12 | struct ConnectionPoolTest::Handler { 13 | QEventLoop loop; 14 | ConnectionPool pool; 15 | 16 | Handler(PoolConfig conf) 17 | : loop() 18 | , pool(conf) 19 | {} 20 | }; 21 | 22 | void ConnectionPoolTest::initTestCase() 23 | { 24 | qInstallMessageHandler(PrgLog::qtMessageOutput); 25 | PoolConfig conf(":configs/test_db.json"); 26 | conf.minConnections = 2; //force this to 2 for test 27 | conf.maxConnections = 5; //force this to 5 for test 28 | conf.connectionLifePeriod = 25000; //force this to 25s for test 29 | conf.inactivityPeriod = 3000; //force this to 10s for test 30 | conf.checkInterval = 1000; //force this to 500ms 31 | _dataHandler = new Handler(conf); 32 | } 33 | 34 | void ConnectionPoolTest::testExplicitUnBorrow() 35 | { 36 | //this expect test_db.json.maxCon = 5 37 | QSharedPointer con1 = ConnectionPool().getConnection(); 38 | QSharedPointer con2 = ConnectionPool().getConnection(); 39 | QSharedPointer con3 = ConnectionPool().getConnection(); 40 | QSharedPointer con4 = ConnectionPool().getConnection(); 41 | QSharedPointer con5 = ConnectionPool().getConnection(); 42 | QSharedPointer con6 = ConnectionPool().getConnection(); 43 | 44 | QList> validConnections; 45 | validConnections << con1 << con2 << con3 << con4 << con5; 46 | QListIterator> validConnectionsIterator(validConnections); 47 | while (validConnectionsIterator.hasNext()) { 48 | QSharedPointer con = validConnectionsIterator.next(); 49 | QCOMPARE(con && con->isInUse(), true); 50 | QCOMPARE(con && con->database().isOpen(), true); 51 | } 52 | 53 | PoolStats stats = ConnectionPool().getPoolStats(); 54 | QCOMPARE(stats._nbAvailable, 0); 55 | QCOMPARE(stats._nbBorrowed, 5); 56 | 57 | QCOMPARE(con6 && con6->isInUse(), false); 58 | QCOMPARE(con6 && con6->database().isOpen(), false); 59 | 60 | //explicit unborrow 61 | QListIterator> validConnectionsIterator2(validConnections); 62 | while (validConnectionsIterator2.hasNext()) { 63 | ConnectionPool().unBorrowConnection(validConnectionsIterator2.next()); 64 | } 65 | PoolStats stats2 = ConnectionPool().getPoolStats(); 66 | QCOMPARE(stats2._nbAvailable, 5); 67 | QCOMPARE(stats2._nbBorrowed, 0); 68 | } 69 | 70 | void ConnectionPoolTest::testImplicitUnBorrow() 71 | { 72 | //this expect test_db.json.maxCon = 5 73 | 74 | { // scope of shared pointers 75 | QSharedPointer con1 = ConnectionPool().getConnection(); 76 | QSharedPointer con2 = ConnectionPool().getConnection(); 77 | QSharedPointer con3 = ConnectionPool().getConnection(); 78 | QSharedPointer con4 = ConnectionPool().getConnection(); 79 | QSharedPointer con5 = ConnectionPool().getConnection(); 80 | QSharedPointer con6 = ConnectionPool().getConnection(); 81 | 82 | QList> validConnections; 83 | validConnections << con1 << con2 << con3 << con4 << con5; 84 | QListIterator> validConnectionsIterator(validConnections); 85 | while (validConnectionsIterator.hasNext()) { 86 | QSharedPointer con = validConnectionsIterator.next(); 87 | QCOMPARE(con && con->isInUse(), true); 88 | QCOMPARE(con && con->database().isOpen(), true); 89 | } 90 | 91 | PoolStats stats = ConnectionPool().getPoolStats(); 92 | QCOMPARE(stats._nbAvailable, 0); 93 | QCOMPARE(stats._nbBorrowed, 5); 94 | 95 | QCOMPARE(con6 && con6->isInUse(), false); 96 | QCOMPARE(con6 && con6->database().isOpen(), false); 97 | } 98 | 99 | PoolStats stats = ConnectionPool().getPoolStats(); 100 | QCOMPARE(stats._nbAvailable, 5); 101 | QCOMPARE(stats._nbBorrowed, 0); 102 | } 103 | 104 | void ConnectionPoolTest::testAsynchronConnectionUsers() 105 | { 106 | uint64_t queryExecTimeMs = 10; //query-execution will take at least 10ms 107 | 108 | for (int i = 0; i < 20; ++i) { 109 | QList > asyncConnectionUsers; 110 | asyncConnectionUsers.append(QSharedPointer(new AsyncConnectionUser("asyncUser1", 0, queryExecTimeMs))); 111 | asyncConnectionUsers.append(QSharedPointer(new AsyncConnectionUser("asyncUser2", 0, queryExecTimeMs))); 112 | asyncConnectionUsers.append(QSharedPointer(new AsyncConnectionUser("asyncUser3", 0, queryExecTimeMs))); 113 | asyncConnectionUsers.append(QSharedPointer(new AsyncConnectionUser("asyncUser4", 0, queryExecTimeMs))); 114 | asyncConnectionUsers.append(QSharedPointer(new AsyncConnectionUser("asyncUser5", 0, queryExecTimeMs))); 115 | asyncConnectionUsers.append(QSharedPointer(new AsyncConnectionUser("asyncUser6", 0, queryExecTimeMs))); 116 | asyncConnectionUsers.append(QSharedPointer(new AsyncConnectionUser("asyncUser7", 0, queryExecTimeMs))); 117 | 118 | QThreadPool* threadPool = new QThreadPool(); 119 | threadPool->setMaxThreadCount(7); 120 | 121 | foreach (QSharedPointer asyncConnectionUser, asyncConnectionUsers) { 122 | threadPool->start(asyncConnectionUser.data()); 123 | } 124 | threadPool->waitForDone(); 125 | 126 | int successCount = 0; 127 | int failCount = 0; 128 | foreach (QSharedPointer asyncConnectionUser, asyncConnectionUsers) { 129 | if (asyncConnectionUser->getSuccess()) { 130 | ++successCount; 131 | } 132 | else { 133 | ++failCount; 134 | } 135 | } 136 | 137 | QCOMPARE(successCount, 5); 138 | QCOMPARE(failCount, 2); 139 | } 140 | } 141 | 142 | //testing release via inactivity and refresh behaviour 143 | void ConnectionPoolTest::testCheckGetConnectionWithWait() 144 | { 145 | uint64_t waitTimout = 20000; //will wait 20s 146 | 147 | for (int i = 0; i < 20; ++i) { 148 | QList > asyncConnectionUsers; 149 | asyncConnectionUsers.append(QSharedPointer(new AsyncConnectionUser("asyncUser1",waitTimout))); 150 | asyncConnectionUsers.append(QSharedPointer(new AsyncConnectionUser("asyncUser2",waitTimout))); 151 | asyncConnectionUsers.append(QSharedPointer(new AsyncConnectionUser("asyncUser3",waitTimout))); 152 | asyncConnectionUsers.append(QSharedPointer(new AsyncConnectionUser("asyncUser4",waitTimout))); 153 | asyncConnectionUsers.append(QSharedPointer(new AsyncConnectionUser("asyncUser5",waitTimout))); 154 | asyncConnectionUsers.append(QSharedPointer(new AsyncConnectionUser("asyncUser6",waitTimout))); 155 | asyncConnectionUsers.append(QSharedPointer(new AsyncConnectionUser("asyncUser7",waitTimout))); 156 | 157 | QThreadPool* threadPool = new QThreadPool(); 158 | threadPool->setMaxThreadCount(7); 159 | 160 | foreach (QSharedPointer asyncConnectionUser, asyncConnectionUsers) { 161 | threadPool->start(asyncConnectionUser.data()); 162 | } 163 | threadPool->waitForDone(); 164 | 165 | int successCount = 0; 166 | int failCount = 0; 167 | foreach (QSharedPointer asyncConnectionUser, asyncConnectionUsers) { 168 | if (asyncConnectionUser->getSuccess()) { 169 | ++successCount; 170 | } 171 | else { 172 | ++failCount; 173 | } 174 | } 175 | QCOMPARE(successCount, 7); //all con should have succeed, we wait the release with waitTimeout 176 | QCOMPARE(failCount, 0); 177 | } 178 | } 179 | 180 | void ConnectionPoolTest::testCheckConnectionPool() { 181 | //this expect test_db.json.maxCon = 5 182 | //this expect test_db.json.minCon = 2 //inactivityPeriod 183 | //this expect inactivityPeriod = 10000 184 | uint64_t waitTimout = 20000; //will wait 20s 185 | QList > asyncConnectionUsers; 186 | asyncConnectionUsers.append(QSharedPointer(new AsyncConnectionUser("asyncUser1",waitTimout))); 187 | asyncConnectionUsers.append(QSharedPointer(new AsyncConnectionUser("asyncUser2",waitTimout))); 188 | asyncConnectionUsers.append(QSharedPointer(new AsyncConnectionUser("asyncUser3",waitTimout))); 189 | asyncConnectionUsers.append(QSharedPointer(new AsyncConnectionUser("asyncUser4",waitTimout))); 190 | asyncConnectionUsers.append(QSharedPointer(new AsyncConnectionUser("asyncUser5",waitTimout))); 191 | 192 | QThreadPool* threadPool = new QThreadPool(); 193 | threadPool->setMaxThreadCount(5); 194 | 195 | //we created 5con, after inactivityPeriod, all con > minCon should be dropped. 196 | foreach (QSharedPointer asyncConnectionUser, asyncConnectionUsers) { 197 | threadPool->start(asyncConnectionUser.data()); 198 | } 199 | //on pourrait check si mnBorrowe>0 ici mais non reliable 200 | qint64 now = QDateTime::currentMSecsSinceEpoch(); 201 | const qint64 startWait = now; 202 | auto st = ConnectionPool().getPoolStats(); 203 | while(!(static_cast(now - startWait) > waitTimout) 204 | && (st._nbAvailable < 2) ){ 205 | QCoreApplication::processEvents(QEventLoop::AllEvents); 206 | now = QDateTime::currentMSecsSinceEpoch(); 207 | st = ConnectionPool().getPoolStats(); 208 | } 209 | //QThread::usleep(11*1000*1000); 210 | //_dataHandler->loop.exec(); 211 | threadPool->waitForDone(); 212 | //at this point we should have 2 con active only 213 | QVERIFY( st._nbAvailable >= 2 ); 214 | } 215 | 216 | void ConnectionPoolTest::cleanupTestCase() 217 | { 218 | ConnectionPool().destroy(); 219 | delete _dataHandler; 220 | } 221 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------