<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Wt: Wt::Dbo::FixedSqlConnectionPool Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Wt
 <span id="projectnumber">3.2.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceWt.html">Wt</a> </li>
<li class="navelem"><a class="el" href="namespaceWt_1_1Dbo.html">Dbo</a> </li>
<li class="navelem"><a class="el" href="classWt_1_1Dbo_1_1FixedSqlConnectionPool.html">FixedSqlConnectionPool</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">Wt::Dbo::FixedSqlConnectionPool Class Reference<div class="ingroups"><a class="el" href="group__dbo.html">Database Objects (Wt::Dbo)</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Wt::Dbo::FixedSqlConnectionPool" --><!-- doxytag: inherits="Wt::Dbo::SqlConnectionPool" -->
<p>A connection pool of fixed size.
<a href="classWt_1_1Dbo_1_1FixedSqlConnectionPool.html#details">More...</a></p>
<p><code>#include <Wt/Dbo/FixedSqlConnectionPool></code></p>
<div class="dynheader">
Inheritance diagram for Wt::Dbo::FixedSqlConnectionPool:</div>
<div class="dyncontent">
<div class="center"><img src="classWt_1_1Dbo_1_1FixedSqlConnectionPool__inherit__graph.png" border="0" usemap="#Wt_1_1Dbo_1_1FixedSqlConnectionPool_inherit__map" alt="Inheritance graph"/></div>
<map name="Wt_1_1Dbo_1_1FixedSqlConnectionPool_inherit__map" id="Wt_1_1Dbo_1_1FixedSqlConnectionPool_inherit__map">
<area shape="rect" href="classWt_1_1Dbo_1_1SqlConnectionPool.html" title="Abstract base class for a SQL connection pool." alt="" coords="21,5,208,32"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classWt_1_1Dbo_1_1FixedSqlConnectionPool-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Dbo_1_1FixedSqlConnectionPool.html#a098f0ef385e4910a15bcfbaf3efc2023">FixedSqlConnectionPool</a> (<a class="el" href="classWt_1_1Dbo_1_1SqlConnection.html">SqlConnection</a> *connection, int size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a fixed connection pool. <a href="#a098f0ef385e4910a15bcfbaf3efc2023"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classWt_1_1Dbo_1_1SqlConnection.html">SqlConnection</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Dbo_1_1FixedSqlConnectionPool.html#a31c8b46293e6779cb2f891c332d329bb">getConnection</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Uses a connection from the pool. <a href="#a31c8b46293e6779cb2f891c332d329bb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Dbo_1_1FixedSqlConnectionPool.html#a50a31bdd5d46ac676c25164653214d7e">returnConnection</a> (<a class="el" href="classWt_1_1Dbo_1_1SqlConnection.html">SqlConnection</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a connection to the pool. <a href="#a50a31bdd5d46ac676c25164653214d7e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1f9cf5fbeae537c96da80fc80f0a66be"></a><!-- doxytag: member="Wt::Dbo::FixedSqlConnectionPool::prepareForDropTables" ref="a1f9cf5fbeae537c96da80fc80f0a66be" args="() const " -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Dbo_1_1FixedSqlConnectionPool.html#a1f9cf5fbeae537c96da80fc80f0a66be">prepareForDropTables</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Prepares all connections in the pool for dropping the tables. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A connection pool of fixed size. </p>
<p>This provides a connection pool of fixed size: its size is determined at startup time, and the pool will not grow as more connections are needed.</p>
<p>This is adequate when the number of threads (which need different connections to work with) is also bounded, like when using a fixed size thread pool. This is for example the case when used in conjunction with Wt. Note that you do not need as many connections as sessions, since <a class="el" href="classWt_1_1Dbo_1_1Session.html" title="A database session.">Session</a> will only use a connection while processing a transaction. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a098f0ef385e4910a15bcfbaf3efc2023"></a><!-- doxytag: member="Wt::Dbo::FixedSqlConnectionPool::FixedSqlConnectionPool" ref="a098f0ef385e4910a15bcfbaf3efc2023" args="(SqlConnection *connection, int size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Wt::Dbo::FixedSqlConnectionPool::FixedSqlConnectionPool </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWt_1_1Dbo_1_1SqlConnection.html">SqlConnection</a> * </td>
<td class="paramname"><em>connection</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a fixed connection pool. </p>
<p>The pool is initialized with the provided <code>connection</code>, which is cloned (<code>size</code> - 1) times.</p>
<p>The pool thus takes ownership of the given connection. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a31c8b46293e6779cb2f891c332d329bb"></a><!-- doxytag: member="Wt::Dbo::FixedSqlConnectionPool::getConnection" ref="a31c8b46293e6779cb2f891c332d329bb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1Dbo_1_1SqlConnection.html">SqlConnection</a> * Wt::Dbo::FixedSqlConnectionPool::getConnection </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Uses a connection from the pool. </p>
<p>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.</p>
<p>This method is called by a <a class="el" href="classWt_1_1Dbo_1_1Session.html" title="A database session.">Session</a> when a new transaction is started. </p>
<p>Implements <a class="el" href="classWt_1_1Dbo_1_1SqlConnectionPool.html#abb43b5dd2db568f8433a8bc43ff6d3fc">Wt::Dbo::SqlConnectionPool</a>.</p>
</div>
</div>
<a class="anchor" id="a50a31bdd5d46ac676c25164653214d7e"></a><!-- doxytag: member="Wt::Dbo::FixedSqlConnectionPool::returnConnection" ref="a50a31bdd5d46ac676c25164653214d7e" args="(SqlConnection *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Dbo::FixedSqlConnectionPool::returnConnection </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWt_1_1Dbo_1_1SqlConnection.html">SqlConnection</a> * </td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a connection to the pool. </p>
<p>This returns a connection to the pool. This method is called by a <a class="el" href="classWt_1_1Dbo_1_1Session.html" title="A database session.">Session</a> after a transaction has been finished. </p>
<p>Implements <a class="el" href="classWt_1_1Dbo_1_1SqlConnectionPool.html#a8699f7ccc487b4578e64ab5e237a77be">Wt::Dbo::SqlConnectionPool</a>.</p>
</div>
</div>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr size="1"><address style="text-align: right; margin: 3px"><small>
Generated on Thu Nov 1 2012 for <a href="http://www.webtoolkit.eu/wt">the
C++ Web Toolkit (Wt)</a> by <a
href="http://www.doxygen.org/index.html"><img src="doxygen.png"
alt="doxygen" border="0" style="vertical-align: middle; display:
inline-block; height: 2em"></a> 1.7.5.1</small></address>
</body>
</html>
