diff options
author | Yann Leboulanger <asterix@lagaule.org> | 2012-05-08 16:19:11 +0400 |
---|---|---|
committer | Yann Leboulanger <asterix@lagaule.org> | 2012-05-08 16:19:11 +0400 |
commit | 97ac572c20083fe0283c4621dc6e54603a32a310 (patch) | |
tree | 42c7b0d6121e71538d804136a8929b7b25adb96c /doc/apidocs/nbxmpp.tls_nb.PyOpenSSLWrapper-class.html |
initial revisionnbxmpp-0.1
Diffstat (limited to 'doc/apidocs/nbxmpp.tls_nb.PyOpenSSLWrapper-class.html')
-rw-r--r-- | doc/apidocs/nbxmpp.tls_nb.PyOpenSSLWrapper-class.html | 367 |
1 files changed, 367 insertions, 0 deletions
diff --git a/doc/apidocs/nbxmpp.tls_nb.PyOpenSSLWrapper-class.html b/doc/apidocs/nbxmpp.tls_nb.PyOpenSSLWrapper-class.html new file mode 100644 index 0000000..7c1e25c --- /dev/null +++ b/doc/apidocs/nbxmpp.tls_nb.PyOpenSSLWrapper-class.html @@ -0,0 +1,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> <a + href="nbxmpp-module.html">Home</a> </th> + + <!-- Tree link --> + <th> <a + href="module-tree.html">Trees</a> </th> + + <!-- Index link --> + <th> <a + href="identifier-index.html">Indices</a> </th> + + <!-- Help link --> + <th> <a + href="help.html">Help</a> </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 nbxmpp</a> :: + <a href="nbxmpp.tls_nb-module.html">Module tls_nb</a> :: + Class 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 private</a>]</span></td></tr> + <tr><td align="right"><span class="options" + >[<a href="frames.html" target="_top">frames</a + >] | <a href="nbxmpp.tls_nb.PyOpenSSLWrapper-class.html" + target="_top">no 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 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'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'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"> </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 code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </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 code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </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 code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </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 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 code</a></span> + </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 code</a></span> + </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 code</a></span> + </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 code</a></span> + </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> <a + href="nbxmpp-module.html">Home</a> </th> + + <!-- Tree link --> + <th> <a + href="module-tree.html">Trees</a> </th> + + <!-- Index link --> + <th> <a + href="identifier-index.html">Indices</a> </th> + + <!-- Help link --> + <th> <a + href="help.html">Help</a> </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> |