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.client_nb-module.html |
initial revisionnbxmpp-0.1
Diffstat (limited to 'doc/apidocs/nbxmpp.client_nb-module.html')
-rw-r--r-- | doc/apidocs/nbxmpp.client_nb-module.html | 243 |
1 files changed, 243 insertions, 0 deletions
diff --git a/doc/apidocs/nbxmpp.client_nb-module.html b/doc/apidocs/nbxmpp.client_nb-module.html new file mode 100644 index 0000000..89df90d --- /dev/null +++ b/doc/apidocs/nbxmpp.client_nb-module.html @@ -0,0 +1,243 @@ +<?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.client_nb</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> :: + Module client_nb + </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.client_nb-module.html" + target="_top">no frames</a>]</span></td></tr> + </table> + </td> + </tr> +</table> +<!-- ==================== MODULE DESCRIPTION ==================== --> +<h1 class="epydoc">Module client_nb</h1><p class="nomargin-top"><span class="codelink"><a href="nbxmpp.client_nb-pysrc.html">source code</a></span></p> +Client class establishs connection to XMPP Server and handles authentication + +<!-- ==================== CLASSES ==================== --> +<a name="section-Classes"></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">Classes</span></td> + <td align="right" valign="top" + ><span class="options">[<a href="#section-Classes" + 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"> + <a href="nbxmpp.client_nb.NonBlockingClient-class.html" class="summary-name">NonBlockingClient</a><br /> + Client class is XMPP connection mountpoint. Objects for authentication, +network communication, roster, xml parsing ... are plugged to client object. +Client implements the abstract behavior - mostly negotioation and callbacks +handling, whereas underlying modules take care of feature-specific logic + </td> + </tr> +</table> +<!-- ==================== VARIABLES ==================== --> +<a name="section-Variables"></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">Variables</span></td> + <td align="right" valign="top" + ><span class="options">[<a href="#section-Variables" + 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"> + <a href="nbxmpp.client_nb-module.html#log" class="summary-name">log</a> = <code title="logging.getLogger('nbxmpp.client_nb')">logging.getLogger('nbxmpp.client_nb')</code> + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <a href="nbxmpp.client_nb-module.html#__package__" class="summary-name">__package__</a> = <code title="'nbxmpp'"><code class="variable-quote">'</code><code class="variable-string">nbxmpp</code><code class="variable-quote">'</code></code> + </td> + </tr> +</table> +<p class="indent-wrapped-lines"><b>Imports:</b> + <span title="socket">socket</span>, + <a href="nbxmpp.transports_nb-module.html" title="nbxmpp.transports_nb">transports_nb</a>, + <a href="nbxmpp.dispatcher_nb-module.html" title="nbxmpp.dispatcher_nb">dispatcher_nb</a>, + <a href="nbxmpp.auth_nb-module.html" title="nbxmpp.auth_nb">auth_nb</a>, + <a href="nbxmpp.roster_nb-module.html" title="nbxmpp.roster_nb">roster_nb</a>, + <a href="nbxmpp.protocol-module.html" title="nbxmpp.protocol">protocol</a>, + <a href="nbxmpp.bosh-module.html" title="nbxmpp.bosh">bosh</a>, + <span title="nbxmpp.protocol.NS_TLS">NS_TLS</span>, + <span title="logging">logging</span> +</p><br /> +<!-- ==================== VARIABLES DETAILS ==================== --> +<a name="section-VariablesDetails"></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">Variables Details</span></td> + <td align="right" valign="top" + ><span class="options">[<a href="#section-VariablesDetails" + class="privatelink" onclick="toggle_private();" + >hide private</a>]</span></td> + </tr> + </table> + </td> +</tr> +</table> +<a name="log"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <h3 class="epydoc">log</h3> + + <dl class="fields"> + </dl> + <dl class="fields"> + <dt>Value:</dt> + <dd><table><tr><td><pre class="variable"> +logging.getLogger('nbxmpp.client_nb') +</pre></td></tr></table> +</dd> + </dl> +</td></tr></table> +</div> +<a name="__package__"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <h3 class="epydoc">__package__</h3> + + <dl class="fields"> + </dl> + <dl class="fields"> + <dt>Value:</dt> + <dd><table><tr><td><pre class="variable"> +<code class="variable-quote">'</code><code class="variable-string">nbxmpp</code><code class="variable-quote">'</code> +</pre></td></tr></table> +</dd> + </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:04 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> |