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 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>MySQL++ Reference Manual</title>
<meta http-equiv="Content-type" content="text/html;charset=iso-8859-1">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head>
<body>
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">scopedconnection.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="scopedconnection_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="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"> Copyright (c) 2010 by Joel Fielder. Others may also hold copyrights</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> on code in this file. See the CREDITS.txt file in the top directory</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> of the distribution for details.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"></span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> This file is part of MySQL++.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"></span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> MySQL++ is free software; you can redistribute it and/or modify it</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> under the terms of the GNU Lesser General Public License as published</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> by the Free Software Foundation; either version 2.1 of the License, or</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> (at your option) any later version.</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"></span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> MySQL++ is distributed in the hope that it will be useful, but WITHOUT</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> License for more details.</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"></span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> You should have received a copy of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> License along with MySQL++; if not, write to the Free Software</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> USA</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">***********************************************************************/</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#if !defined(MYSQLPP_SCOPEDCONNECTION_H)</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor"></span><span class="preprocessor">#define MYSQLPP_SCOPEDCONNECTION_H</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#include "<a class="code" href="common_8h.html">common.h</a>"</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">namespace </span>mysqlpp {</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#if !defined(DOXYGEN_IGNORE)</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor"></span><span class="comment">// Make Doxygen ignore this</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">class </span>MYSQLPP_EXPORT Connection;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">class </span>MYSQLPP_EXPORT ConnectionPool;</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> <span class="preprocessor"></span></div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classmysqlpp_1_1ScopedConnection.html"> 48</a></span> <span class="keyword">class </span>MYSQLPP_EXPORT <a class="code" href="classmysqlpp_1_1ScopedConnection.html">ScopedConnection</a></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> {</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">explicit</span> <a class="code" href="classmysqlpp_1_1ScopedConnection.html">ScopedConnection</a>(<a class="code" href="classmysqlpp_1_1ConnectionPool.html">ConnectionPool</a>& pool, <span class="keywordtype">bool</span> safe = <span class="keyword">false</span>);</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  ~<a class="code" href="classmysqlpp_1_1ScopedConnection.html">ScopedConnection</a>();</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div>
<div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="classmysqlpp_1_1ScopedConnection.html#a91fb3a20deb9c80552f3d82995cfcf8e"> 68</a></span>  <a class="code" href="classmysqlpp_1_1Connection.html">Connection</a>* <a class="code" href="classmysqlpp_1_1ScopedConnection.html#a91fb3a20deb9c80552f3d82995cfcf8e">operator-></a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> connection_; }</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="classmysqlpp_1_1ScopedConnection.html#ab781773026ebb3e7f41535681ae3566e"> 71</a></span>  <a class="code" href="classmysqlpp_1_1Connection.html">Connection</a>& <a class="code" href="classmysqlpp_1_1ScopedConnection.html#ab781773026ebb3e7f41535681ae3566e">operator*</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> *connection_; }</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="classmysqlpp_1_1ScopedConnection.html#afdaa60a8cc8e34a708d5c4635a28aee1"> 74</a></span>  <span class="keyword">operator</span> <span class="keywordtype">void</span>*() <span class="keyword">const</span> { <span class="keywordflow">return</span> connection_; }</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="comment">// ScopedConnection objects cannot be copied. We want them to be</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="comment">// tightly scoped to their use point, not put in containers or</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="comment">// passed around promiscuously.</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <a class="code" href="classmysqlpp_1_1ScopedConnection.html">ScopedConnection</a>(<span class="keyword">const</span> <a class="code" href="classmysqlpp_1_1ScopedConnection.html">ScopedConnection</a>& no_copies); </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keyword">const</span> <a class="code" href="classmysqlpp_1_1ScopedConnection.html">ScopedConnection</a>& operator=(<span class="keyword">const</span> <a class="code" href="classmysqlpp_1_1ScopedConnection.html">ScopedConnection</a>& no_copies);</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <a class="code" href="classmysqlpp_1_1ConnectionPool.html">ConnectionPool</a>& pool_;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <a class="code" href="classmysqlpp_1_1Connection.html">Connection</a>* <span class="keyword">const</span> connection_;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> };</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> } <span class="comment">// end namespace mysqlpp</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="preprocessor">#endif // !defined(MYSQLPP_SCOPEDCONNECTION_H)</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="preprocessor"></span></div>
<div class="ttc" id="classmysqlpp_1_1ScopedConnection_html"><div class="ttname"><a href="classmysqlpp_1_1ScopedConnection.html">mysqlpp::ScopedConnection</a></div><div class="ttdoc">Grabs a Connection from a ConnectionPool on construction and releases it back to the pool on destruct...</div><div class="ttdef"><b>Definition:</b> scopedconnection.h:48</div></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_1ScopedConnection_html_ab781773026ebb3e7f41535681ae3566e"><div class="ttname"><a href="classmysqlpp_1_1ScopedConnection.html#ab781773026ebb3e7f41535681ae3566e">mysqlpp::ScopedConnection::operator*</a></div><div class="ttdeci">Connection & operator*() const </div><div class="ttdoc">Dereference. </div><div class="ttdef"><b>Definition:</b> scopedconnection.h:71</div></div>
<div class="ttc" id="classmysqlpp_1_1ScopedConnection_html_a91fb3a20deb9c80552f3d82995cfcf8e"><div class="ttname"><a href="classmysqlpp_1_1ScopedConnection.html#a91fb3a20deb9c80552f3d82995cfcf8e">mysqlpp::ScopedConnection::operator-></a></div><div class="ttdeci">Connection * operator->() const </div><div class="ttdoc">Access the Connection pointer. </div><div class="ttdef"><b>Definition:</b> scopedconnection.h:68</div></div>
<div class="ttc" id="common_8h_html"><div class="ttname"><a href="common_8h.html">common.h</a></div><div class="ttdoc">This file includes top-level definitions for use both internal to the library, and outside it...</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 18 2015 18:55:03 for MySQL++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
|