File: classmysqlpp_1_1ScopedConnection.html

package info (click to toggle)
mysql%2B%2B 3.2.2%2Bpristine-2
  • links: PTS
  • area: main
  • in suites: stretch
  • size: 15,724 kB
  • ctags: 10,567
  • sloc: cpp: 35,668; sh: 3,683; makefile: 846; perl: 786
file content (137 lines) | stat: -rwxr-xr-x 9,148 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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
<!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&#160;Page</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>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </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:a91fb3a20deb9c80552f3d82995cfcf8e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a91fb3a20deb9c80552f3d82995cfcf8e"></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#a91fb3a20deb9c80552f3d82995cfcf8e">operator-&gt;</a> () const </td></tr>
<tr class="memdesc:a91fb3a20deb9c80552f3d82995cfcf8e"><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:a91fb3a20deb9c80552f3d82995cfcf8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab781773026ebb3e7f41535681ae3566e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab781773026ebb3e7f41535681ae3566e"></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#ab781773026ebb3e7f41535681ae3566e">operator*</a> () const </td></tr>
<tr class="memdesc:ab781773026ebb3e7f41535681ae3566e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dereference. <br/></td></tr>
<tr class="separator:ab781773026ebb3e7f41535681ae3566e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afdaa60a8cc8e34a708d5c4635a28aee1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afdaa60a8cc8e34a708d5c4635a28aee1"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1ScopedConnection.html#afdaa60a8cc8e34a708d5c4635a28aee1">operator void *</a> () const </td></tr>
<tr class="memdesc:afdaa60a8cc8e34a708d5c4635a28aee1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Truthiness operator. <br/></td></tr>
<tr class="separator:afdaa60a8cc8e34a708d5c4635a28aee1"><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 class="anchor" id="a048b8756b1cd598785a709967894eeae"></a>
<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 class="anchor" id="ab8b21eb30678cb0530d6dbc1eed38bef"></a>
<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>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 Wed Mar 18 2015 18:55:03 for MySQL++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>