QgsConnectionPoolGroup< T > Class Template Reference

#include <qgsconnectionpool.h>

Classes
struct	Item

Public Member Functions
	QgsConnectionPoolGroup (const QString &ci)
	~QgsConnectionPoolGroup ()
T	acquire ()
void	release (T conn)

Static Public Attributes
static const int	maxConcurrentConnections

Protected Member Functions
void	initTimer (QObject *parent)
void	onConnectionExpired ()

Protected Attributes
QString	connInfo
QStack< Item >	conns
QMutex	connMutex
QSemaphore	sem
QTimer *	expirationTimer

Detailed Description

template<typename T>
class QgsConnectionPoolGroup< T >

Template that stores data related to one server.

It is assumed that following functions exist:

• void qgsConnectionPool_ConnectionCreate(QString name, T& c) ... create a new connection
• void qgsConnectionPool_ConnectionDestroy(T c) ... destroy the connection
• QString qgsConnectionPool_ConnectionToName(T c) ... lookup connection's name (path)

Because of issues with templates and QObject's signals and slots, this class only provides helper functions for QObject-related functionality - the place which uses the template is resonsible for:

• being derived from QObject
• calling initTimer( this ) in constructor
• having handleConnectionExpired() slot that calls onConnectionExpired()
• having startExpirationTimer(), stopExpirationTimer() slots to start/stop the expiration timer

For an example on how to use the template class, have a look at the implementation in postgres/spatialite providers.

Definition at line 51 of file qgsconnectionpool.h.

Constructor & Destructor Documentation

template<typename T >

QgsConnectionPoolGroup< T >::QgsConnectionPoolGroup ( const QString &  ci )

inline

Definition at line 63 of file qgsconnectionpool.h.

template<typename T >

QgsConnectionPoolGroup< T >::~QgsConnectionPoolGroup ( )

inline

Definition at line 70 of file qgsconnectionpool.h.

References QgsConnectionPoolGroup< T >::Item::c, and QgsConnectionPoolGroup< T >::conns.

Member Function Documentation

template<typename T >

T QgsConnectionPoolGroup< T >::acquire ( )

inline

Definition at line 78 of file qgsconnectionpool.h.

References QgsConnectionPoolGroup< T >::Item::c, QgsConnectionPoolGroup< T >::connInfo, QgsConnectionPoolGroup< T >::connMutex, QgsConnectionPoolGroup< T >::conns, QgsConnectionPoolGroup< T >::expirationTimer, and QgsConnectionPoolGroup< T >::sem.

template<typename T >

void QgsConnectionPoolGroup< T >::initTimer ( QObject *  parent )

inlineprotected

Definition at line 135 of file qgsconnectionpool.h.

References CONN_POOL_EXPIRATION_TIME, and QgsConnectionPoolGroup< T >::expirationTimer.

template<typename T >

void QgsConnectionPoolGroup< T >::onConnectionExpired ( )

inlineprotected

Definition at line 145 of file qgsconnectionpool.h.

References CONN_POOL_EXPIRATION_TIME, QgsConnectionPoolGroup< T >::connMutex, QgsConnectionPoolGroup< T >::conns, QgsConnectionPoolGroup< T >::expirationTimer, and index.

template<typename T >

void QgsConnectionPoolGroup< T >::release ( T  conn )

inline

Definition at line 114 of file qgsconnectionpool.h.

References QgsConnectionPoolGroup< T >::Item::c, QgsConnectionPoolGroup< T >::connMutex, QgsConnectionPoolGroup< T >::conns, QgsConnectionPoolGroup< T >::expirationTimer, QgsConnectionPoolGroup< T >::Item::lastUsedTime, and QgsConnectionPoolGroup< T >::sem.

Member Data Documentation

template<typename T >

QString QgsConnectionPoolGroup< T >::connInfo

protected

Definition at line 175 of file qgsconnectionpool.h.

Referenced by QgsConnectionPoolGroup< T >::acquire().

template<typename T >

QMutex QgsConnectionPoolGroup< T >::connMutex

protected

Definition at line 177 of file qgsconnectionpool.h.

Referenced by QgsConnectionPoolGroup< T >::acquire(), QgsConnectionPoolGroup< T >::onConnectionExpired(), and QgsConnectionPoolGroup< T >::release().

template<typename T >

QStack<Item> QgsConnectionPoolGroup< T >::conns

protected

Definition at line 176 of file qgsconnectionpool.h.

Referenced by QgsConnectionPoolGroup< T >::acquire(), QgsConnectionPoolGroup< T >::onConnectionExpired(), QgsConnectionPoolGroup< T >::release(), and QgsConnectionPoolGroup< T >::~QgsConnectionPoolGroup().

template<typename T >

QTimer* QgsConnectionPoolGroup< T >::expirationTimer

protected

Definition at line 179 of file qgsconnectionpool.h.

Referenced by QgsConnectionPoolGroup< T >::acquire(), QgsConnectionPoolGroup< T >::initTimer(), QgsConnectionPoolGroup< T >::onConnectionExpired(), and QgsConnectionPoolGroup< T >::release().

template<typename T >

const int QgsConnectionPoolGroup< T >::maxConcurrentConnections

static

Definition at line 55 of file qgsconnectionpool.h.

template<typename T >

QSemaphore QgsConnectionPoolGroup< T >::sem

protected

Definition at line 178 of file qgsconnectionpool.h.

Referenced by QgsConnectionPoolGroup< T >::acquire(), and QgsConnectionPoolGroup< T >::release().

---

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

• /tmp/buildd/qgis-2.4.0+unstable1/src/core/qgsconnectionpool.h