nbxmpp.tls_nb.PyOpenSSLWrapper-class.html 14.9 KB
Newer Older
Yann Leboulanger's avatar
Yann Leboulanger committed
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 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>nbxmpp.tls_nb.PyOpenSSLWrapper</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="nbxmpp-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://python-nbxmpp.gajim.org">python-nbxmpp</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="nbxmpp-module.html">Package&nbsp;nbxmpp</a> ::
        <a href="nbxmpp.tls_nb-module.html">Module&nbsp;tls_nb</a> ::
        Class&nbsp;PyOpenSSLWrapper
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="nbxmpp.tls_nb.PyOpenSSLWrapper-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class PyOpenSSLWrapper</h1><p class="nomargin-top"><span class="codelink"><a href="nbxmpp.tls_nb-pysrc.html#PyOpenSSLWrapper">source&nbsp;code</a></span></p>
<center>
<center>  <map id="uml_class_diagram_for_nbxmpp_t_2" name="uml_class_diagram_for_nbxmpp_t_2">
<area shape="rect" id="node225" href="nbxmpp.tls_nb.PyOpenSSLWrapper-class.html#__init__" title="nbxmpp.tls_nb.PyOpenSSLWrapper.__init__" alt="" coords="17,116,284,135"/>
<area shape="rect" id="node225" href="nbxmpp.tls_nb.PyOpenSSLWrapper-class.html#is_numtoolarge" title="Magic methods don&#39;t need documentation" alt="" coords="17,135,284,153"/>
<area shape="rect" id="node225" href="nbxmpp.tls_nb.PyOpenSSLWrapper-class.html#recv" title="Receive wrapper for SSL object" alt="" coords="17,153,284,172"/>
<area shape="rect" id="node225" href="nbxmpp.tls_nb.PyOpenSSLWrapper-class.html#send" title="Send wrapper for SSL object" alt="" coords="17,172,284,191"/>
<area shape="rect" id="node1" href="nbxmpp.tls_nb.PyOpenSSLWrapper-class.html" title="Wrapper class for PyOpenSSL&#39;s recv() and send() methods" alt="" coords="5,83,296,197"/>
<area shape="rect" id="node226" href="nbxmpp.tls_nb.SSLWrapper.Error-class.html" title="Generic SSL Error Wrapper" alt="" coords="111,31,189,49"/>
<area shape="rect" id="node2" href="nbxmpp.tls_nb.SSLWrapper-class.html" title="Abstract SSLWrapper base class" alt="" coords="99,6,200,63"/>
</map>
  <img src="uml_class_diagram_for_nbxmpp_t_2.gif" alt='' usemap="#uml_class_diagram_for_nbxmpp_t_2" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
Wrapper class for PyOpenSSL's recv() and send() methods

<!-- ==================== NESTED CLASSES ==================== -->
<a name="section-NestedClasses"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Nested Classes</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-NestedClasses"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="nbxmpp.tls_nb.SSLWrapper-class.html">SSLWrapper</a></code></b>:
      <code><a href="nbxmpp.tls_nb.SSLWrapper.Error-class.html">Error</a></code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="nbxmpp.tls_nb.PyOpenSSLWrapper-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">*args</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="nbxmpp.tls_nb-pysrc.html#PyOpenSSLWrapper.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="nbxmpp.tls_nb.PyOpenSSLWrapper-class.html#is_numtoolarge" class="summary-sig-name">is_numtoolarge</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">e</span>)</span><br />
      Magic methods don't need documentation</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="nbxmpp.tls_nb-pysrc.html#PyOpenSSLWrapper.is_numtoolarge">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="nbxmpp.tls_nb.PyOpenSSLWrapper-class.html#recv" class="summary-sig-name">recv</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">bufsize</span>,
        <span class="summary-sig-arg">flags</span>=<span class="summary-sig-default">None</span>)</span><br />
      Receive wrapper for SSL object</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="nbxmpp.tls_nb-pysrc.html#PyOpenSSLWrapper.recv">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="nbxmpp.tls_nb.PyOpenSSLWrapper-class.html#send" class="summary-sig-name">send</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">data</span>,
        <span class="summary-sig-arg">flags</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">now</span>=<span class="summary-sig-default">False</span>)</span><br />
      Send wrapper for SSL object</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="nbxmpp.tls_nb-pysrc.html#PyOpenSSLWrapper.send">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">*args</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="nbxmpp.tls_nb-pysrc.html#PyOpenSSLWrapper.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  
  <dl class="fields">
    <dt>Overrides:
        <a href="nbxmpp.tls_nb.SSLWrapper-class.html#__init__">SSLWrapper.__init__</a>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="is_numtoolarge"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">is_numtoolarge</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">e</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="nbxmpp.tls_nb-pysrc.html#PyOpenSSLWrapper.is_numtoolarge">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  Magic methods don't need documentation
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="recv"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">recv</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">bufsize</span>,
        <span class="sig-arg">flags</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="nbxmpp.tls_nb-pysrc.html#PyOpenSSLWrapper.recv">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Receive wrapper for SSL object</p>
<p>We can return None out of this function to signal that no data is
available right now. Better than an exception, which differs
depending on which SSL lib we're using. Unfortunately returning ''
can indicate that the socket has been closed, so to be sure, we avoid
this by returning None.</p>
  <dl class="fields">
    <dt>Overrides:
        <a href="nbxmpp.tls_nb.SSLWrapper-class.html#recv">SSLWrapper.recv</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="send"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">send</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">data</span>,
        <span class="sig-arg">flags</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">now</span>=<span class="sig-default">False</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="nbxmpp.tls_nb-pysrc.html#PyOpenSSLWrapper.send">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  Send wrapper for SSL object
  <dl class="fields">
    <dt>Overrides:
        <a href="nbxmpp.tls_nb.SSLWrapper-class.html#send">SSLWrapper.send</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="nbxmpp-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://python-nbxmpp.gajim.org">python-nbxmpp</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Tue May  8 11:18:08 2012
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>