File: classmysqlpp_1_1ScopedConnection.html

package info (click to toggle)
mysql%2B%2B 3.2.5-2.1
  • links: PTS
  • area: main
  • in suites: bookworm
  • size: 18,360 kB
  • sloc: cpp: 35,788; sh: 3,693; perl: 789; makefile: 730
file content (181 lines) | stat: -rwxr-xr-x 11,057 bytes parent folder | download | duplicates (3)
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
<!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++: mysqlpp::ScopedConnection Class Reference</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++
       &#160;<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&amp;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&amp;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>
<!-- 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 id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>mysqlpp</b></li><li class="navelem"><a class="el" href="classmysqlpp_1_1ScopedConnection.html">ScopedConnection</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classmysqlpp_1_1ScopedConnection-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">mysqlpp::ScopedConnection Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Grabs a <a class="el" href="classmysqlpp_1_1Connection.html" title="Manages the connection to the database server.">Connection</a> from a <a class="el" href="classmysqlpp_1_1ConnectionPool.html" title="Manages a pool of connections for programs that need more than one Connection object at a time,...">ConnectionPool</a> on construction and releases it back to the pool on destruction, and provides access to the relevant <a class="el" href="classmysqlpp_1_1Connection.html" title="Manages the connection to the database server.">Connection</a> pointer.  
 <a href="classmysqlpp_1_1ScopedConnection.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="scopedconnection_8h_source.html">scopedconnection.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a048b8756b1cd598785a709967894eeae"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1ScopedConnection.html#a048b8756b1cd598785a709967894eeae">ScopedConnection</a> (<a class="el" href="classmysqlpp_1_1ConnectionPool.html">ConnectionPool</a> &amp;pool, bool safe=false)</td></tr>
<tr class="memdesc:a048b8756b1cd598785a709967894eeae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Standard constructor.  <a href="#a048b8756b1cd598785a709967894eeae">More...</a><br /></td></tr>
<tr class="separator:a048b8756b1cd598785a709967894eeae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab8b21eb30678cb0530d6dbc1eed38bef"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1ScopedConnection.html#ab8b21eb30678cb0530d6dbc1eed38bef">~ScopedConnection</a> ()</td></tr>
<tr class="memdesc:ab8b21eb30678cb0530d6dbc1eed38bef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#ab8b21eb30678cb0530d6dbc1eed38bef">More...</a><br /></td></tr>
<tr class="separator:ab8b21eb30678cb0530d6dbc1eed38bef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adfdccb62813dbd052750a205e0cd1d29"><td class="memItemLeft" align="right" valign="top"><a id="adfdccb62813dbd052750a205e0cd1d29"></a>
<a class="el" href="classmysqlpp_1_1Connection.html">Connection</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1ScopedConnection.html#adfdccb62813dbd052750a205e0cd1d29">operator-&gt;</a> () const</td></tr>
<tr class="memdesc:adfdccb62813dbd052750a205e0cd1d29"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access the <a class="el" href="classmysqlpp_1_1Connection.html" title="Manages the connection to the database server.">Connection</a> pointer. <br /></td></tr>
<tr class="separator:adfdccb62813dbd052750a205e0cd1d29"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a53f10b7b4dcf8e8ab7a801b01bcd8479"><td class="memItemLeft" align="right" valign="top"><a id="a53f10b7b4dcf8e8ab7a801b01bcd8479"></a>
<a class="el" href="classmysqlpp_1_1Connection.html">Connection</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1ScopedConnection.html#a53f10b7b4dcf8e8ab7a801b01bcd8479">operator *</a> () const</td></tr>
<tr class="memdesc:a53f10b7b4dcf8e8ab7a801b01bcd8479"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dereference. <br /></td></tr>
<tr class="separator:a53f10b7b4dcf8e8ab7a801b01bcd8479"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af78d1e0d9b08ead6741775b9fa1f1f76"><td class="memItemLeft" align="right" valign="top"><a id="af78d1e0d9b08ead6741775b9fa1f1f76"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1ScopedConnection.html#af78d1e0d9b08ead6741775b9fa1f1f76">operator void *</a> () const</td></tr>
<tr class="memdesc:af78d1e0d9b08ead6741775b9fa1f1f76"><td class="mdescLeft">&#160;</td><td class="mdescRight">Truthiness operator. <br /></td></tr>
<tr class="separator:af78d1e0d9b08ead6741775b9fa1f1f76"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Grabs a <a class="el" href="classmysqlpp_1_1Connection.html" title="Manages the connection to the database server.">Connection</a> from a <a class="el" href="classmysqlpp_1_1ConnectionPool.html" title="Manages a pool of connections for programs that need more than one Connection object at a time,...">ConnectionPool</a> on construction and releases it back to the pool on destruction, and provides access to the relevant <a class="el" href="classmysqlpp_1_1Connection.html" title="Manages the connection to the database server.">Connection</a> pointer. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a048b8756b1cd598785a709967894eeae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a048b8756b1cd598785a709967894eeae">&#9670;&nbsp;</a></span>ScopedConnection()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">mysqlpp::ScopedConnection::ScopedConnection </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classmysqlpp_1_1ConnectionPool.html">ConnectionPool</a> &amp;&#160;</td>
          <td class="paramname"><em>pool</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>safe</em> = <code>false</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Standard constructor. </p>
<p>Grabs a <a class="el" href="classmysqlpp_1_1Connection.html" title="Manages the connection to the database server.">Connection</a> from the specified pool. </p>

</div>
</div>
<a id="ab8b21eb30678cb0530d6dbc1eed38bef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab8b21eb30678cb0530d6dbc1eed38bef">&#9670;&nbsp;</a></span>~ScopedConnection()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">mysqlpp::ScopedConnection::~ScopedConnection </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Destructor. </p>
<p>Releases the <a class="el" href="classmysqlpp_1_1Connection.html" title="Manages the connection to the database server.">Connection</a> back to the <a class="el" href="classmysqlpp_1_1ConnectionPool.html" title="Manages a pool of connections for programs that need more than one Connection object at a time,...">ConnectionPool</a>. </p>

<p class="reference">References <a class="el" href="classmysqlpp_1_1ConnectionPool.html#ac51a7a63ce4d8825c3f7b05f4b8bfe68">mysqlpp::ConnectionPool::release()</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="scopedconnection_8h_source.html">scopedconnection.h</a></li>
<li>scopedconnection.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Jul 21 2019 05:32:21 for MySQL++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>