~groldster/ubuntu/maverick/psycopg2/merge-611040

« back to all changes in this revision

Viewing changes to doc/api/private/psycopg2.pool.ThreadedConnectionPool-class.html

  • Committer: Bazaar Package Importer
  • Author(s): Fabio Tranchitella
  • Date: 2006-08-09 10:28:30 UTC
  • Revision ID: james.westby@ubuntu.com-20060809102830-grac1dsp24uyqfp4
Tags: upstream-2.0.4
ImportĀ upstreamĀ versionĀ 2.0.4

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" encoding="utf-8"?>
 
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 
3
          "DTD/xhtml1-transitional.dtd">
 
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
5
<head>
 
6
  <title>psycopg2.pool.ThreadedConnectionPool</title>
 
7
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
 
8
<script type="text/javascript">
 
9
<!--
 
10
function setFrame(url1, url2){
 
11
    parent.frames[1].location.href = url1;
 
12
    parent.frames[2].location.href = url2;
 
13
}
 
14
-->
 
15
</script>
 
16
</head>
 
17
<body bgcolor="white" text="black" link="blue" vlink="#204080"
 
18
      alink="#204080">
 
19
 
 
20
<!-- =========== START OF NAVBAR =========== -->
 
21
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
22
  <tr valign="middle">
 
23
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="psycopg2-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
24
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
25
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
26
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
27
    <th class="navbar" width="100%"></th>
 
28
  </tr>
 
29
</table>
 
30
<table width="100%" cellpadding="0" cellspacing="0">
 
31
  <tr valign="top">
 
32
    <td width="100%">
 
33
      <span class="breadcrumbs">
 
34
        <a href="psycopg2-module.html">Package&nbsp;psycopg2</a> ::
 
35
        <a href="psycopg2.pool-module.html">Module&nbsp;pool</a> ::
 
36
        Class&nbsp;ThreadedConnectionPool
 
37
      </span><br />
 
38
    </td>
 
39
    <td><table cellpadding="0" cellspacing="0">
 
40
      <tr><td align="right"><span class="options">[show&nbsp;private&nbsp;|&nbsp;<a href="../public/psycopg2.pool.ThreadedConnectionPool-class.html">hide&nbsp;private</a>]</span></td></tr>
 
41
      <tr><td align="right"><span class="options">[<a href="frames.html" target="_top">frames</a>&nbsp;|&nbsp;<a href="psycopg2.pool.ThreadedConnectionPool-class.html" target="_top">no&nbsp;frames</a>]</span></td></tr>
 
42
    </table></td>
 
43
</tr></table>
 
44
 
 
45
<!-- =========== START OF CLASS DESCRIPTION =========== -->
 
46
<h2 class="class">Type ThreadedConnectionPool</h2>
 
47
 
 
48
<pre class="base-tree">
 
49
            <a href="__builtin__.object-class.html"><code>object</code></a> --+    
 
50
                     |    
 
51
<a href="psycopg2.pool.AbstractConnectionPool-class.html"><code>AbstractConnectionPool</code></a> --+
 
52
                         |
 
53
                        <strong class="uidshort">ThreadedConnectionPool</strong>
 
54
</pre><br />
 
55
 
 
56
<hr/>
 
57
 
 
58
<p>A connection pool that works with the threading module.</p>
 
59
<hr/>
 
60
 
 
61
 
 
62
<!-- =========== START OF METHOD SUMMARY =========== -->
 
63
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
64
<tr bgcolor="#70b0f0" class="summary">
 
65
  <th colspan="2">Method Summary</th></tr>
 
66
<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>
 
67
  <td><code><span class="summary-sig"><a href="psycopg2.pool.ThreadedConnectionPool-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class="summary-sig-arg">self</span>,
 
68
          <span class="summary-sig-arg">minconn</span>,
 
69
          <span class="summary-sig-arg">maxconn</span>,
 
70
          <span class="summary-sig-vararg">*args</span>,
 
71
          <span class="summary-sig-kwarg">**kwargs</span>)</span></code>
 
72
<br />
 
73
Initialize the threading lock.</td></tr>
 
74
<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>
 
75
  <td><code><span class="summary-sig"><a href="psycopg2.pool.ThreadedConnectionPool-class.html#closeall" class="summary-sig-name"><code>closeall</code></a>(<span class="summary-sig-arg">self</span>)</span></code>
 
76
<br />
 
77
Close all connections (even the one currently in use.)</td></tr>
 
78
<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>
 
79
  <td><code><span class="summary-sig"><a href="psycopg2.pool.ThreadedConnectionPool-class.html#getconn" class="summary-sig-name"><code>getconn</code></a>(<span class="summary-sig-arg">self</span>,
 
80
          <span class="summary-sig-arg">key</span>)</span></code>
 
81
<br />
 
82
Get a free connection and assign it to 'key' if not None.</td></tr>
 
83
<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>
 
84
  <td><code><span class="summary-sig"><a href="psycopg2.pool.ThreadedConnectionPool-class.html#putconn" class="summary-sig-name"><code>putconn</code></a>(<span class="summary-sig-arg">self</span>,
 
85
          <span class="summary-sig-arg">conn</span>,
 
86
          <span class="summary-sig-arg">key</span>,
 
87
          <span class="summary-sig-arg">close</span>)</span></code>
 
88
<br />
 
89
Put away an unused connection.</td></tr>
 
90
<tr bgcolor="#e8f0f8" class="group">
 
91
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from AbstractConnectionPool</th></tr>
 
92
<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>
 
93
  <td><code><span class="summary-sig"><a href="../private/psycopg2.pool.AbstractConnectionPool-class.html#_closeall" class="summary-sig-name"><code>_closeall</code></a>(<span class="summary-sig-arg">self</span>)</span></code>
 
94
<br />
 
95
Close all connections.</td></tr>
 
96
<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>
 
97
  <td><code><span class="summary-sig"><a href="../private/psycopg2.pool.AbstractConnectionPool-class.html#_connect" class="summary-sig-name"><code>_connect</code></a>(<span class="summary-sig-arg">self</span>,
 
98
          <span class="summary-sig-arg">key</span>)</span></code>
 
99
<br />
 
100
Create a new connection and assign it to 'key' if not None.</td></tr>
 
101
<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>
 
102
  <td><code><span class="summary-sig"><a href="../private/psycopg2.pool.AbstractConnectionPool-class.html#_getconn" class="summary-sig-name"><code>_getconn</code></a>(<span class="summary-sig-arg">self</span>,
 
103
          <span class="summary-sig-arg">key</span>)</span></code>
 
104
<br />
 
105
Get a free connection and assign it to 'key' if not None.</td></tr>
 
106
<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>
 
107
  <td><code><span class="summary-sig"><a href="../private/psycopg2.pool.AbstractConnectionPool-class.html#_getkey" class="summary-sig-name"><code>_getkey</code></a>(<span class="summary-sig-arg">self</span>)</span></code>
 
108
<br />
 
109
Return a new unique key.</td></tr>
 
110
<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>
 
111
  <td><code><span class="summary-sig"><a href="../private/psycopg2.pool.AbstractConnectionPool-class.html#_putconn" class="summary-sig-name"><code>_putconn</code></a>(<span class="summary-sig-arg">self</span>,
 
112
          <span class="summary-sig-arg">conn</span>,
 
113
          <span class="summary-sig-arg">key</span>,
 
114
          <span class="summary-sig-arg">close</span>)</span></code>
 
115
<br />
 
116
Put away a connection.</td></tr>
 
117
<tr bgcolor="#e8f0f8" class="group">
 
118
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from object</th></tr>
 
119
<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>
 
120
  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
 
121
<br />
 
122
x.__delattr__('name') &lt;==&gt; del x.name</td></tr>
 
123
<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>
 
124
  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
 
125
<br />
 
126
x.__getattribute__('name') &lt;==&gt; x.name</td></tr>
 
127
<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>
 
128
  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class="summary-sig-arg">x</span>)</span></code>
 
129
<br />
 
130
Return hash(x)...</td></tr>
 
131
<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>
 
132
  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class="summary-sig-arg">T</span>,
 
133
          <span class="summary-sig-arg">S</span>,
 
134
          <span class="summary-sig-vararg">...</span>)</span></code>
 
135
<br />
 
136
Return a new object with type S, a subtype of T...</td></tr>
 
137
<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>
 
138
  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
 
139
<br />
 
140
helper for pickle</td></tr>
 
141
<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>
 
142
  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
 
143
<br />
 
144
helper for pickle</td></tr>
 
145
<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>
 
146
  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class="summary-sig-arg">x</span>)</span></code>
 
147
<br />
 
148
Return repr(x)...</td></tr>
 
149
<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>
 
150
  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
 
151
<br />
 
152
x.__setattr__('name', value) &lt;==&gt; x.name = value</td></tr>
 
153
<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>
 
154
  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class="summary-sig-arg">x</span>)</span></code>
 
155
<br />
 
156
Return str(x)...</td></tr>
 
157
</table><br />
 
158
 
 
159
 
 
160
<!-- =========== START OF METHOD DETAILS =========== -->
 
161
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
162
<tr bgcolor="#70b0f0" class="details">
 
163
  <th colspan="2">Method Details</th></tr>
 
164
</table>
 
165
 
 
166
<a name="__init__"></a>
 
167
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
168
  <h3><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
 
169
          <span class="sig-arg">minconn</span>,
 
170
          <span class="sig-arg">maxconn</span>,
 
171
          <span class="sig-vararg">*args</span>,
 
172
          <span class="sig-kwarg">**kwargs</span>)</span>
 
173
    <br /><em class="fname">(Constructor)</em>
 
174
  </h3>
 
175
<p>Initialize the threading lock.</p>
 
176
  <dl><dt></dt><dd>
 
177
    <dl><dt>Overrides:</dt>
 
178
      <dd><a href="psycopg2.pool.AbstractConnectionPool-class.html#__init__"><code>psycopg2.pool.AbstractConnectionPool.__init__</code></a></dd>
 
179
    </dl>
 
180
  </dd></dl>
 
181
</td></tr></table>
 
182
 
 
183
<a name="closeall"></a>
 
184
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
185
  <h3><span class="sig"><span class="sig-name">closeall</span>(<span class="sig-arg">self</span>)</span>
 
186
  </h3>
 
187
<p>Close all connections (even the one currently in use.)</p>
 
188
  <dl><dt></dt><dd>
 
189
  </dd></dl>
 
190
</td></tr></table>
 
191
 
 
192
<a name="getconn"></a>
 
193
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
194
  <h3><span class="sig"><span class="sig-name">getconn</span>(<span class="sig-arg">self</span>,
 
195
          <span class="sig-arg">key</span>=<span class="sig-default">None</span>)</span>
 
196
  </h3>
 
197
<p>Get a free connection and assign it to 'key' if not None.</p>
 
198
  <dl><dt></dt><dd>
 
199
  </dd></dl>
 
200
</td></tr></table>
 
201
 
 
202
<a name="putconn"></a>
 
203
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
204
  <h3><span class="sig"><span class="sig-name">putconn</span>(<span class="sig-arg">self</span>,
 
205
          <span class="sig-arg">conn</span>=<span class="sig-default">None</span>,
 
206
          <span class="sig-arg">key</span>=<span class="sig-default">None</span>,
 
207
          <span class="sig-arg">close</span>=<span class="sig-default">False</span>)</span>
 
208
  </h3>
 
209
<p>Put away an unused connection.</p>
 
210
  <dl><dt></dt><dd>
 
211
  </dd></dl>
 
212
</td></tr></table>
 
213
<br />
 
214
 
 
215
 
 
216
<!-- =========== START OF NAVBAR =========== -->
 
217
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
218
  <tr valign="middle">
 
219
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="psycopg2-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
220
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
221
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
222
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
223
    <th class="navbar" width="100%"></th>
 
224
  </tr>
 
225
</table>
 
226
 
 
227
<table border="0" cellpadding="0" cellspacing="0" width="100%">
 
228
  <tr>
 
229
    <td align="left" class="footer">Generated by Epydoc 2.1 on Sat Jan 14 01:42:35 2006</td>
 
230
    <td align="right" class="footer">
 
231
      <a href="http://epydoc.sourceforge.net">http://epydoc.sf.net</a>
 
232
    </td>
 
233
  </tr>
 
234
</table>
 
235
</body>
 
236
</html>