1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
<!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>
<title>MySQL++ Reference Manual</title>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MySQL++: cpool.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">MySQL++
 <span id="projectnumber">3.2.5</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</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>
<div class="header">
<div class="headertitle">
<div class="title">cpool.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="cpool_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">/***********************************************************************</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> Copyright (c) 2007-2008 by Educational Technology Resources, Inc. and</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> (c) 2007 by Jonathan Wakely. Others may also hold copyrights on</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> code in this file. See the CREDITS.txt file in the top directory</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> of the distribution for details.</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> This file is part of MySQL++.</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"></span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> MySQL++ is free software; you can redistribute it and/or modify it</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> under the terms of the GNU Lesser General Public License as published</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> by the Free Software Foundation; either version 2.1 of the License, or</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> (at your option) any later version.</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"></span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> MySQL++ is distributed in the hope that it will be useful, but WITHOUT</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> License for more details.</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> You should have received a copy of the GNU Lesser General Public</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> License along with MySQL++; if not, write to the Free Software</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> USA</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">***********************************************************************/</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#if !defined(MYSQLPP_CPOOL_H)</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#define MYSQLPP_CPOOL_H</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "<a class="code" href="beemutex_8h.html">beemutex.h</a>"</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include <list></span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#include <assert.h></span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#include <time.h></span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">namespace </span>mysqlpp {</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#if !defined(DOXYGEN_IGNORE)</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">// Make Doxygen ignore this</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">class </span>MYSQLPP_EXPORT Connection;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="classmysqlpp_1_1ConnectionPool.html"> 68</a></span> <span class="keyword">class </span>MYSQLPP_EXPORT <a class="code" href="classmysqlpp_1_1ConnectionPool.html">ConnectionPool</a></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> {</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="classmysqlpp_1_1ConnectionPool.html#acc1262db33d586284651825ff076a8d7"> 72</a></span>  <a class="code" href="classmysqlpp_1_1ConnectionPool.html#acc1262db33d586284651825ff076a8d7">ConnectionPool</a>() { }</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="classmysqlpp_1_1ConnectionPool.html#a2cee954229416e24da07f5e208b35b09"> 78</a></span>  <span class="keyword">virtual</span> <a class="code" href="classmysqlpp_1_1ConnectionPool.html#a2cee954229416e24da07f5e208b35b09">~ConnectionPool</a>() { assert(empty()); }</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div><div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="classmysqlpp_1_1ConnectionPool.html#ac7f3bd443b9a70fb21ce86fa7ced880e"> 81</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classmysqlpp_1_1ConnectionPool.html#ac7f3bd443b9a70fb21ce86fa7ced880e">empty</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> pool_.empty(); }</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keyword">virtual</span> <a class="code" href="classmysqlpp_1_1Connection.html">Connection</a>* exchange(<span class="keyword">const</span> <a class="code" href="classmysqlpp_1_1Connection.html">Connection</a>* pc);</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keyword">virtual</span> <a class="code" href="classmysqlpp_1_1Connection.html">Connection</a>* grab();</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> release(<span class="keyword">const</span> <a class="code" href="classmysqlpp_1_1Connection.html">Connection</a>* pc);</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <span class="keywordtype">void</span> remove(<span class="keyword">const</span> <a class="code" href="classmysqlpp_1_1Connection.html">Connection</a>* pc);</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> </div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  <span class="keyword">virtual</span> <a class="code" href="classmysqlpp_1_1Connection.html">Connection</a>* safe_grab();</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> </div><div class="line"><a name="l00165"></a><span class="lineno"><a class="line" href="classmysqlpp_1_1ConnectionPool.html#ac410ed5cb3032aed048fb3a275629654"> 165</a></span>  <span class="keywordtype">void</span> <a class="code" href="classmysqlpp_1_1ConnectionPool.html#ac410ed5cb3032aed048fb3a275629654">shrink</a>() { clear(<span class="keyword">false</span>); }</div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> </div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  <span class="keywordtype">void</span> clear(<span class="keywordtype">bool</span> all = <span class="keyword">true</span>);</div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> </div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  <span class="keyword">virtual</span> <a class="code" href="classmysqlpp_1_1Connection.html">Connection</a>* create() = 0;</div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> </div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> destroy(<a class="code" href="classmysqlpp_1_1Connection.html">Connection</a>*) = 0;</div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> </div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> max_idle_time() = 0;</div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> </div><div class="line"><a name="l00210"></a><span class="lineno"><a class="line" href="classmysqlpp_1_1ConnectionPool.html#a852e802aa80a2e608926760a1d9b4591"> 210</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="classmysqlpp_1_1ConnectionPool.html#a852e802aa80a2e608926760a1d9b4591">size</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> pool_.size(); }</div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span> </div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  <span class="keyword">struct </span>ConnectionInfo {</div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  <a class="code" href="classmysqlpp_1_1Connection.html">Connection</a>* conn;</div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span>  time_t last_used;</div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  <span class="keywordtype">bool</span> in_use;</div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span> </div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  ConnectionInfo(<a class="code" href="classmysqlpp_1_1Connection.html">Connection</a>* c) :</div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  conn(c),</div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span>  last_used(time(0)),</div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span>  in_use(true)</div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  {</div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span>  }</div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span> </div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  <span class="comment">// Strict weak ordering for ConnectionInfo objects.</span></div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  <span class="comment">// </span></div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  <span class="comment">// This ordering defines all in-use connections to be "less</span></div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span>  <span class="comment">// than" those not in use. Within each group, connections</span></div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span>  <span class="comment">// less recently touched are less than those more recent.</span></div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span>  <span class="keywordtype">bool</span> operator<(<span class="keyword">const</span> ConnectionInfo& rhs)<span class="keyword"> const</span></div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="keyword"> </span>{</div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span>  <span class="keyword">const</span> ConnectionInfo& lhs = *<span class="keyword">this</span>;</div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span>  <span class="keywordflow">return</span> lhs.in_use == rhs.in_use ?</div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span>  lhs.last_used < rhs.last_used :</div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span>  lhs.in_use;</div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span>  }</div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span>  };</div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span>  <span class="keyword">typedef</span> std::list<ConnectionInfo> PoolT;</div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span>  <span class="keyword">typedef</span> PoolT::iterator PoolIt;</div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span> </div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  Connection* find_mru();</div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span>  <span class="keywordtype">void</span> remove(<span class="keyword">const</span> PoolIt& it);</div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span>  <span class="keywordtype">void</span> remove_old_connections();</div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span> </div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span>  PoolT pool_;</div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span>  BeecryptMutex mutex_;</div><div class="line"><a name="l00250"></a><span class="lineno"> 250</span> };</div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span> </div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span> } <span class="comment">// end namespace mysqlpp</span></div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span> </div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="preprocessor">#endif // !defined(MYSQLPP_CPOOL_H)</span></div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span> </div><div class="ttc" id="classmysqlpp_1_1Connection_html"><div class="ttname"><a href="classmysqlpp_1_1Connection.html">mysqlpp::Connection</a></div><div class="ttdoc">Manages the connection to the database server.</div><div class="ttdef"><b>Definition:</b> connection.h:59</div></div>
<div class="ttc" id="classmysqlpp_1_1ConnectionPool_html"><div class="ttname"><a href="classmysqlpp_1_1ConnectionPool.html">mysqlpp::ConnectionPool</a></div><div class="ttdoc">Manages a pool of connections for programs that need more than one Connection object at a time,...</div><div class="ttdef"><b>Definition:</b> cpool.h:68</div></div>
<div class="ttc" id="classmysqlpp_1_1ConnectionPool_html_a852e802aa80a2e608926760a1d9b4591"><div class="ttname"><a href="classmysqlpp_1_1ConnectionPool.html#a852e802aa80a2e608926760a1d9b4591">mysqlpp::ConnectionPool::size</a></div><div class="ttdeci">size_t size() const</div><div class="ttdoc">Returns the current size of the internal connection pool.</div><div class="ttdef"><b>Definition:</b> cpool.h:210</div></div>
<div class="ttc" id="classmysqlpp_1_1ConnectionPool_html_ac7f3bd443b9a70fb21ce86fa7ced880e"><div class="ttname"><a href="classmysqlpp_1_1ConnectionPool.html#ac7f3bd443b9a70fb21ce86fa7ced880e">mysqlpp::ConnectionPool::empty</a></div><div class="ttdeci">bool empty() const</div><div class="ttdoc">Returns true if pool is empty.</div><div class="ttdef"><b>Definition:</b> cpool.h:81</div></div>
<div class="ttc" id="beemutex_8h_html"><div class="ttname"><a href="beemutex_8h.html">beemutex.h</a></div><div class="ttdoc">MUTually EXclusive lock class.</div></div>
<div class="ttc" id="classmysqlpp_1_1ConnectionPool_html_acc1262db33d586284651825ff076a8d7"><div class="ttname"><a href="classmysqlpp_1_1ConnectionPool.html#acc1262db33d586284651825ff076a8d7">mysqlpp::ConnectionPool::ConnectionPool</a></div><div class="ttdeci">ConnectionPool()</div><div class="ttdoc">Create empty pool.</div><div class="ttdef"><b>Definition:</b> cpool.h:72</div></div>
<div class="ttc" id="classmysqlpp_1_1ConnectionPool_html_ac410ed5cb3032aed048fb3a275629654"><div class="ttname"><a href="classmysqlpp_1_1ConnectionPool.html#ac410ed5cb3032aed048fb3a275629654">mysqlpp::ConnectionPool::shrink</a></div><div class="ttdeci">void shrink()</div><div class="ttdoc">Remove all unused connections from the pool.</div><div class="ttdef"><b>Definition:</b> cpool.h:165</div></div>
<div class="ttc" id="classmysqlpp_1_1ConnectionPool_html_a2cee954229416e24da07f5e208b35b09"><div class="ttname"><a href="classmysqlpp_1_1ConnectionPool.html#a2cee954229416e24da07f5e208b35b09">mysqlpp::ConnectionPool::~ConnectionPool</a></div><div class="ttdeci">virtual ~ConnectionPool()</div><div class="ttdoc">Destroy object.</div><div class="ttdef"><b>Definition:</b> cpool.h:78</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Jul 21 2019 05:32:20 for MySQL++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
|
