Wt  4.0.2
Public Member Functions | List of all members
Wt::Dbo::SqlConnectionPool Class Referenceabstract

Abstract base class for a SQL connection pool. More...

#include <Wt/Dbo/SqlConnectionPool.h>

Inheritance diagram for Wt::Dbo::SqlConnectionPool:
Inheritance graph
[legend]

Public Member Functions

virtual ~SqlConnectionPool ()
 Destructor.
 
virtual std::unique_ptr< SqlConnectiongetConnection ()=0
 Uses a connection from the pool. More...
 
virtual void returnConnection (std::unique_ptr< SqlConnection >)=0
 Returns a connection to the pool. More...
 
virtual void prepareForDropTables () const =0
 Prepares all connections in the pool for dropping the tables.
 

Detailed Description

Abstract base class for a SQL connection pool.

An sql connection pool manages a pool of connections. It is shared between multiple sessions to allow these sessions to use a connection while handling a transaction. Note that a session only needs a connection while in-transaction, and thus you only need as much connections as the number of concurrent transactions.

Member Function Documentation

virtual std::unique_ptr<SqlConnection> Wt::Dbo::SqlConnectionPool::getConnection ( )
pure virtual

Uses a connection from the pool.

This returns a connection from the pool that can be used. If the pool has no more connection available, the pool may decide to grow or block until a connection is returned.

This method is called by a Session when a new transaction is started.

Implemented in Wt::Dbo::FixedSqlConnectionPool.

virtual void Wt::Dbo::SqlConnectionPool::returnConnection ( std::unique_ptr< SqlConnection )
pure virtual

Returns a connection to the pool.

This returns a connection to the pool. This method is called by a Session after a transaction has been finished.

Implemented in Wt::Dbo::FixedSqlConnectionPool.


Generated on Fri Nov 24 2017 for the C++ Web Toolkit (Wt) by doxygen 1.8.11