This class implements a connection pool for the PostGIS driver. More...

#include <ConnectionPool.h>

Inheritance diagram for te::pgis::ConnectionPool:

Classes
class	ConnectionPoolImpl

Public Member Functions
void	finalize ()
	It closes all connections and clears all resources managed by the pool. More...

Connection *	getConnection (int id=-1)
	It returns a connection from the pool. More...

te::pgis::DataSource *	getDataSource () const

std::size_t	getInitialPoolSize () const
	It returns the initial number of connections opened by the pool at its startup. More...

unsigned int	getMaxIdleTime () const
	It returns the maximum idle time in seconds that a connection can be maintained in the pool without being used. More...

std::size_t	getMaxPoolSize () const
	It returns the maximum number of connections managed by the pool. More...

std::size_t	getMinPoolSize () const
	It returns the minimum number of connections managed by the pool. More...

std::size_t	getPoolSize () const
	It returns the number of connections in the pool. More...

void	idle ()
	It releases the connections that are not in use for a long time. More...

void	initialize ()
	It initializes the connections to be managed by the pool. More...

bool	isInitialized () const
	It returns true if the connection pool is initialized, otherwise it returns false. More...

bool	isValid () const
	It checks if all the connections in the pool are valid (the communication channel is ok). More...

void	release (Connection *conn)
	It brings the informed connection back to the pool. More...

void	setInitialPoolSize (std::size_t size)
	It sets the initial number of connections opened by the pool at its startup. More...

void	setMaxIdleTime (unsigned int t)
	It sets the maximum idle time that a connection can be maintained in the pool without being used. More...

void	setMaxPoolSize (std::size_t size)
	It sets the maximum number of connections managed by the pool. More...

void	setMinPoolSize (std::size_t size)
	It sets the minimum number of connections managed by the pool. More...

Private Member Functions
	ConnectionPool (DataSource *ds)
	It creates a new connection pool for the database informed. More...

int	getAvailableConnectionId ()
	Gets the first available connection. More...

te::pgis::Connection *	getConnectionById (const int &id)
	Gets a connection by id. More...

void	setConnectionInUse (const int &id, const bool &inUse)
	Sets the state of the connection by id. More...

	~ConnectionPool ()
	Destructor. More...

Private Attributes
ConnectionPoolImpl *	m_pImpl
	A pointer to the pool implementation. More...

Friends
class	DataSource

Detailed Description

This class implements a connection pool for the PostGIS driver.

See also: AbstractConnectionPool, ConnectionPoolManager, Connection

Definition at line 49 of file ConnectionPool.h.

Constructor & Destructor Documentation

te::pgis::ConnectionPool::ConnectionPool ( DataSource * ds )

private

It creates a new connection pool for the database informed.

Parameters

ds	The data source using this pool.

Definition at line 432 of file ConnectionPool.cpp.

References m_pImpl.

te::pgis::ConnectionPool::~ConnectionPool ( )

private

Destructor.

It will automatically close all connections to a PostgreSQL database.

Definition at line 438 of file ConnectionPool.cpp.

References m_pImpl.

Member Function Documentation

void te::pgis::ConnectionPool::finalize ( )

virtual

It closes all connections and clears all resources managed by the pool.

Exceptions

Exception It may throws an exception if there is a connection in use or if it is not possible to stop the pool.

Note: Successive calls won't have effect.; Thread-safe.

Implements te::da::AbstractConnectionPool.

Definition at line 150 of file ConnectionPool.cpp.

References te::common::FreeContents(), te::pgis::ConnectionPool::ConnectionPoolImpl::m_availableConnectionsIds, te::pgis::ConnectionPool::ConnectionPoolImpl::m_connections, te::pgis::ConnectionPool::ConnectionPoolImpl::m_initialized, te::pgis::ConnectionPool::ConnectionPoolImpl::m_mtx, m_pImpl, te::pgis::ConnectionPool::ConnectionPoolImpl::m_poolSize, and TE_TR.

Referenced by te::pgis::DataSource::close().

int te::pgis::ConnectionPool::getAvailableConnectionId ( )

private

Gets the first available connection.

Returns: The first available connection.

Definition at line 410 of file ConnectionPool.cpp.

References te::pgis::ConnectionPool::ConnectionPoolImpl::m_availableConnectionsIds, and m_pImpl.

Referenced by getConnection().

te::pgis::Connection * te::pgis::ConnectionPool::getConnection ( int id = -1 )

It returns a connection from the pool.

Returns: A connection if one is available or an exception will be raised.

Exceptions

Exception It throws an exception if it is not possible to get a connection.

Warning: You must call the release() method after using the connection to assure that the connection was returned to the pool. This approach will increase concurrency in the connection.

Note: PostGIS extended method.

Definition at line 300 of file ConnectionPool.cpp.

Referenced by te::pgis::DataSource::getConnection(), te::pgis::Transactor::getConnection(), and te::pgis::ScopedConnection::ScopedConnection().

te::pgis::Connection * te::pgis::ConnectionPool::getConnectionById ( const int & id )

private

Gets a connection by id.

Returns: A connection by id.

Definition at line 418 of file ConnectionPool.cpp.

References te::pgis::ConnectionPool::ConnectionPoolImpl::m_connections, and m_pImpl.

Referenced by getConnection().

te::pgis::DataSource * te::pgis::ConnectionPool::getDataSource ( ) const

Definition at line 251 of file ConnectionPool.cpp.

References te::pgis::ConnectionPool::ConnectionPoolImpl::m_ds, and m_pImpl.

std::size_t te::pgis::ConnectionPool::getInitialPoolSize ( ) const

virtual

It returns the initial number of connections opened by the pool at its startup.

Returns: The initial number of connections opened by the pool at its startup.

Note: Thread-safe.

Implements te::da::AbstractConnectionPool.

Definition at line 261 of file ConnectionPool.cpp.

References te::pgis::ConnectionPool::ConnectionPoolImpl::m_initialPoolSize, and m_pImpl.

unsigned int te::pgis::ConnectionPool::getMaxIdleTime ( ) const

It returns the maximum idle time in seconds that a connection can be maintained in the pool without being used.

Returns: The maximum idle time that a connection can be maintained in the pool without being used.

Note: Thread-safe.; PostGIS extended method.

Definition at line 370 of file ConnectionPool.cpp.

References te::pgis::ConnectionPool::ConnectionPoolImpl::m_maxIdleTime, and m_pImpl.

std::size_t te::pgis::ConnectionPool::getMaxPoolSize ( ) const

virtual

It returns the maximum number of connections managed by the pool.

Returns: The maximum number of connections managed by the pool.

Note: Thread-safe.

Implements te::da::AbstractConnectionPool.

Definition at line 287 of file ConnectionPool.cpp.

References te::pgis::ConnectionPool::ConnectionPoolImpl::m_maxPoolSize, and m_pImpl.

std::size_t te::pgis::ConnectionPool::getMinPoolSize ( ) const

virtual

It returns the minimum number of connections managed by the pool.

Returns: The minimum number of connections managed by the pool.

Note: Thread-safe.

Implements te::da::AbstractConnectionPool.

Definition at line 274 of file ConnectionPool.cpp.

References te::pgis::ConnectionPool::ConnectionPoolImpl::m_minPoolSize, and m_pImpl.

std::size_t te::pgis::ConnectionPool::getPoolSize ( ) const

virtual

It returns the number of connections in the pool.

Returns: The number of the connections in the pool.

Note: Thread-safe.

Implements te::da::AbstractConnectionPool.

Definition at line 256 of file ConnectionPool.cpp.

References m_pImpl, and te::pgis::ConnectionPool::ConnectionPoolImpl::m_poolSize.

void te::pgis::ConnectionPool::idle ( )

virtual

It releases the connections that are not in use for a long time.

This method will try to keep the pool with the minimum number of opened connections. It will be invoked by the connection pool manager when its thread wakeup. It must check the idle connections and must destroy them.

Note: Thread-safe.

Implements te::da::AbstractConnectionPool.

Definition at line 177 of file ConnectionPool.cpp.

References d, isInitialized(), te::pgis::ConnectionPool::ConnectionPoolImpl::m_connections, te::pgis::ConnectionPool::ConnectionPoolImpl::m_maxIdleTime, te::pgis::ConnectionPool::ConnectionPoolImpl::m_maxPoolSize, te::pgis::ConnectionPool::ConnectionPoolImpl::m_minPoolSize, te::pgis::ConnectionPool::ConnectionPoolImpl::m_mtx, m_pImpl, and te::pgis::ConnectionPool::ConnectionPoolImpl::m_poolSize.

void te::pgis::ConnectionPool::initialize ( )

virtual

It initializes the connections to be managed by the pool.

Exceptions

Exception It throws an exception if it is not possible to initialize the pool.

Note: Successive calls won't have effect.; Thread-safe.

Implements te::da::AbstractConnectionPool.

Definition at line 85 of file ConnectionPool.cpp.

Referenced by te::pgis::DataSource::open().

bool te::pgis::ConnectionPool::isInitialized ( ) const

virtual

It returns true if the connection pool is initialized, otherwise it returns false.

Returns: True if the connection pool is initialized, otherwise it returns false.

Note: Thread-safe.

Implements te::da::AbstractConnectionPool.

Definition at line 246 of file ConnectionPool.cpp.

References te::pgis::ConnectionPool::ConnectionPoolImpl::m_initialized, and m_pImpl.

Referenced by idle(), initialize(), and te::pgis::DataSource::isOpened().

bool te::pgis::ConnectionPool::isValid ( ) const

virtual

It checks if all the connections in the pool are valid (the communication channel is ok).

Returns: It returns true if all the connections are valid (the communication channel is ok), otherwise it returns false.

Note: Thread-safe.

Implements te::da::AbstractConnectionPool.

Definition at line 225 of file ConnectionPool.cpp.

References te::pgis::ConnectionPool::ConnectionPoolImpl::m_connections, te::pgis::ConnectionPool::ConnectionPoolImpl::m_mtx, and m_pImpl.

Referenced by te::pgis::DataSource::isValid().

void te::pgis::ConnectionPool::release ( Connection * conn )

It brings the informed connection back to the pool.

Parameters

conn	The connection to be put back the pool.

Note: PostGIS extended method.

Definition at line 360 of file ConnectionPool.cpp.

References te::pgis::Connection::m_id, te::pgis::Connection::m_lastuse, te::pgis::ConnectionPool::ConnectionPoolImpl::m_mtx, m_pImpl, and setConnectionInUse().

Referenced by te::pgis::DataSource::closeConnection(), and te::pgis::ScopedConnection::release().

void te::pgis::ConnectionPool::setConnectionInUse	(	const int &	id,
		const bool &	inUse
	)

private

Sets the state of the connection by id.

Parameters

id	The connection id.
inUse	The connection state.

Definition at line 383 of file ConnectionPool.cpp.

References te::pgis::ConnectionPool::ConnectionPoolImpl::m_availableConnectionsIds, te::pgis::ConnectionPool::ConnectionPoolImpl::m_connections, and m_pImpl.

Referenced by getConnection(), initialize(), and release().

void te::pgis::ConnectionPool::setInitialPoolSize ( std::size_t size )

virtual

It sets the initial number of connections opened by the pool at its startup.

Parameters

size	It specifies the initial number of connections that must be opened by the pool at its startup.

Note: The pool must be reset before the changes take effect.; Thread-safe.

Implements te::da::AbstractConnectionPool.

Definition at line 266 of file ConnectionPool.cpp.

References te::pgis::ConnectionPool::ConnectionPoolImpl::m_initialPoolSize, te::pgis::ConnectionPool::ConnectionPoolImpl::m_mtx, and m_pImpl.

void te::pgis::ConnectionPool::setMaxIdleTime ( unsigned int t )

It sets the maximum idle time that a connection can be maintained in the pool without being used.

Parameters

t	It specifies the maximum idle time in seconds that a connection can be maintained in the pool without being used.

Note: A zero value indicates that the connections will not be removed from the pool when it is not being used for a while.; Thread-safe.; PostGIS extended method.

Definition at line 375 of file ConnectionPool.cpp.

References te::pgis::ConnectionPool::ConnectionPoolImpl::m_maxIdleTime, te::pgis::ConnectionPool::ConnectionPoolImpl::m_mtx, and m_pImpl.

void te::pgis::ConnectionPool::setMaxPoolSize ( std::size_t size )

virtual

It sets the maximum number of connections managed by the pool.

Parameters

size	The maximum number of connections that the pool must manage.

Note: The pool must be reset before the changes take effect.; Thread-safe.

Implements te::da::AbstractConnectionPool.

Definition at line 292 of file ConnectionPool.cpp.

References te::pgis::ConnectionPool::ConnectionPoolImpl::m_maxPoolSize, te::pgis::ConnectionPool::ConnectionPoolImpl::m_mtx, and m_pImpl.

void te::pgis::ConnectionPool::setMinPoolSize ( std::size_t size )

virtual

It sets the minimum number of connections managed by the pool.

Parameters

size	The minimum number of connections that the pool must manage.

Note: The pool must be reset before the changes take effect.; Thread-safe.

Implements te::da::AbstractConnectionPool.

Definition at line 279 of file ConnectionPool.cpp.

References te::pgis::ConnectionPool::ConnectionPoolImpl::m_minPoolSize, te::pgis::ConnectionPool::ConnectionPoolImpl::m_mtx, and m_pImpl.

Friends And Related Function Documentation

friend class DataSource

friend

Definition at line 173 of file ConnectionPool.h.

Member Data Documentation

ConnectionPoolImpl* te::pgis::ConnectionPool::m_pImpl

private

A pointer to the pool implementation.

Definition at line 169 of file ConnectionPool.h.

Referenced by ConnectionPool(), finalize(), getAvailableConnectionId(), getConnection(), getConnectionById(), getDataSource(), getInitialPoolSize(), getMaxIdleTime(), getMaxPoolSize(), getMinPoolSize(), getPoolSize(), idle(), initialize(), isInitialized(), isValid(), release(), setConnectionInUse(), setInitialPoolSize(), setMaxIdleTime(), setMaxPoolSize(), setMinPoolSize(), and ~ConnectionPool().

The documentation for this class was generated from the following files:

Classes

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation