trunk/psycopg2/doc/api/private/psycopg2.pool.ThreadedConnectionPool-class.html

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