File: classmysqlpp_1_1ScopedConnection.html

package info (click to toggle)
mysql%2B%2B 3.2.1%2Bpristine-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 13,624 kB
  • ctags: 11,252
  • sloc: cpp: 35,659; sh: 3,034; makefile: 951; perl: 786
file content (123 lines) | stat: -rw-r--r-- 8,160 bytes parent folder | download
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
<!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">
	<link href="refman.css" rel="stylesheet" type="text/css">
</head>
<body>
<!-- Generated by Doxygen 1.4.7 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li id="current"><a href="annotated.html"><span>Classes</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
  </ul></div>
<div class="tabs">
  <ul>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul></div>
<div class="nav">
<b>mysqlpp</b>::<a class="el" href="classmysqlpp_1_1ScopedConnection.html">ScopedConnection</a></div>
<h1>mysqlpp::ScopedConnection Class Reference</h1><!-- doxytag: class="mysqlpp::ScopedConnection" -->Grabs a <a class="el" href="classmysqlpp_1_1Connection.html">Connection</a> from a <a class="el" href="classmysqlpp_1_1ConnectionPool.html">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">Connection</a> pointer.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="scopedconnection_8h-source.html">scopedconnection.h</a>&gt;</code>
<p>
Collaboration diagram for mysqlpp::ScopedConnection:<p><center><img src="classmysqlpp_1_1ScopedConnection__coll__graph.png" border="0" usemap="#mysqlpp_1_1ScopedConnection__coll__map" alt="Collaboration graph"></center>
<map name="mysqlpp_1_1ScopedConnection__coll__map">
<area href="classmysqlpp_1_1ConnectionPool.html" shape="rect" coords="51,187,237,213" alt="">
<area href="classmysqlpp_1_1BeecryptMutex.html" shape="rect" coords="5,96,192,123" alt="">
<area href="classmysqlpp_1_1Connection.html" shape="rect" coords="352,187,512,213" alt="">
<area href="classmysqlpp_1_1OptionalExceptions.html" shape="rect" coords="216,96,429,123" alt="">
<area href="classmysqlpp_1_1DBDriver.html" shape="rect" coords="605,96,752,123" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classmysqlpp_1_1ScopedConnection-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1ScopedConnection.html#048b8756b1cd598785a709967894eeae">ScopedConnection</a> (<a class="el" href="classmysqlpp_1_1ConnectionPool.html">ConnectionPool</a> &amp;pool, bool safe=false)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Standard constructor.  <a href="#048b8756b1cd598785a709967894eeae"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1ScopedConnection.html#b8b21eb30678cb0530d6dbc1eed38bef">~ScopedConnection</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor.  <a href="#b8b21eb30678cb0530d6dbc1eed38bef"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="91fb3a20deb9c80552f3d82995cfcf8e"></a><!-- doxytag: member="mysqlpp::ScopedConnection::operator-&gt;" ref="91fb3a20deb9c80552f3d82995cfcf8e" args="() const " -->
<a class="el" href="classmysqlpp_1_1Connection.html">Connection</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1ScopedConnection.html#91fb3a20deb9c80552f3d82995cfcf8e">operator-&gt;</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Access the <a class="el" href="classmysqlpp_1_1Connection.html">Connection</a> pointer. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1b882b2a3a4d0388ebbaec2fc4d94abc"></a><!-- doxytag: member="mysqlpp::ScopedConnection::operator *" ref="1b882b2a3a4d0388ebbaec2fc4d94abc" args="() const " -->
<a class="el" href="classmysqlpp_1_1Connection.html">Connection</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1ScopedConnection.html#1b882b2a3a4d0388ebbaec2fc4d94abc">operator *</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Dereference. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fdaa60a8cc8e34a708d5c4635a28aee1"></a><!-- doxytag: member="mysqlpp::ScopedConnection::operator void *" ref="fdaa60a8cc8e34a708d5c4635a28aee1" args="() const " -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1ScopedConnection.html#fdaa60a8cc8e34a708d5c4635a28aee1">operator void *</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Truthiness operator. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Grabs a <a class="el" href="classmysqlpp_1_1Connection.html">Connection</a> from a <a class="el" href="classmysqlpp_1_1ConnectionPool.html">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">Connection</a> pointer. 
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="048b8756b1cd598785a709967894eeae"></a><!-- doxytag: member="mysqlpp::ScopedConnection::ScopedConnection" ref="048b8756b1cd598785a709967894eeae" args="(ConnectionPool &amp;pool, bool safe=false)" -->
<div class="memitem">
<div class="memproto">
      <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;&nbsp;</td>
          <td class="paramname"> <em>pool</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>safe</em> = <code>false</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [explicit]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Standard constructor. 
<p>
Grabs a <a class="el" href="classmysqlpp_1_1Connection.html">Connection</a> from the specified pool. 
</div>
</div><p>
<a class="anchor" name="b8b21eb30678cb0530d6dbc1eed38bef"></a><!-- doxytag: member="mysqlpp::ScopedConnection::~ScopedConnection" ref="b8b21eb30678cb0530d6dbc1eed38bef" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">mysqlpp::ScopedConnection::~ScopedConnection           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Destructor. 
<p>
Releases the <a class="el" href="classmysqlpp_1_1Connection.html">Connection</a> back to the <a class="el" href="classmysqlpp_1_1ConnectionPool.html">ConnectionPool</a>. 
</div>
</div><p>
<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>scopedconnection.cpp</ul>
<hr size="1"><address style="align: right;"><small>Generated on 10 Dec 2013 for MySQL++ by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>